isusermemberofgroup_21r2 Function

This page contains information related to an old version of the a!isUserMemberOfGroup() Function.

Old versions do not appear in category lists; only the newest versions are listed.

To take advantage of the latest features and improvements, we always recommend you use the latest versions of functions whenever possible. See the latest version's page for information about what's been changed.

Function

isusermemberofgroup_21r2( username, groupId )

Identifies whether or not a user belongs to a group.

Parameters

Keyword Type Description

username

Text

The username to check for group membership.

groupId

Group

The Id of the group.

Returns

Boolean

Usage considerations

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.

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

isusermemberofgroup_21r2("john.doe",2) returns false

Open in Github Built: Fri, Nov 19, 2021 (11:59:11 AM)

On This Page

FEEDBACK