This page contains information related to an old version of the a!isUserMemberOfGroup() Function.
To take advantage of the latest features and improvements, we always recommend you use the latest version whenever possible. See the latest version's page for information about what's been changed.
FunctionCopy link to clipboard
isusermemberofgroup_21r2( username, groupId )
Identifies whether or not a user belongs to a group.
ParametersCopy link to clipboard
| Keyword | Type | Description |
|---|---|---|
|
|
Text |
The username to check for group membership. |
|
|
Group |
The Id of the group. |
ReturnsCopy link to clipboard
Boolean
Usage considerationsCopy link to clipboard
Returns true when the user belongs to the specified group, except when security rules prohibit users from knowing this information.
For example, this function returns false to keep membership awareness secure in the following instance:
- A high privacy group is passed in AND
- A user other than the logged in user is passed in AND
- The function is executed within the context of a basic user who is not an administrator of the high privacy group
A basic user is not allowed to know whether another user is a member of such groups.
isusermemberofgroup_21r2() cannot be used to define a column of process report data or in a process event.
ExamplesCopy link to clipboard
You can copy and paste these examples into the Expression Rule Designer to see how this works.
1
isusermemberofgroup_21r2("john.doe",2)
Copy
Returns false.
Feature compatibilityCopy link to clipboard
The table below lists this function's compatibility with various features in Appian.
| Feature | Compatibility | Note |
|---|---|---|
| Portals | Partially compatible | Can be used with Appian Portals if it is connected using an integration and web API. |
| Offline Mobile | Compatible | |
| Sync-Time Custom Record Fields | Incompatible | |
| Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
| Process Reports | Incompatible | Cannot be used to configure a process report. |
| Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
| Process Autoscaling | Compatible |