Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !


Warning

The availability of the users personal data may be impacted by the recent changes by Atlassian in order to meet GDPR compliance. See the following for more information:


Info
titleAvailability
  • This routine is available starting with katl-commons 1.0.
  • This routine is available for Jira server and cloud deployment options.


Syntax

userInGroup(group, user)

...

Excerpt

Verifies if the selected user is in the selected group(s).

Parameters

Parameter name

Type

Required

Description

group

string / string[]

Yes

Name(s) of the group(s) the user should belong to.

user

string

Yes

Name or key of the user that needs to be verified.

Note

On the server version, it searches by the user key first and if there is no result - by the user name as well. On the cloud version, the search is done by the user key only.


Return type

boolean (true/false)

A A "true" return value means that the user associated with the specified username or userkey belongs to the given group(s).

Example

Example 1 Server

Code Block
userInGroup("Administrators", "Admin1");

Returns: True Returns "true" if Admin1 is included in Administrators group and "Administratorsfalse" group or False if Admin1 is not included in Administrators group.

Example 2 Cloud

Code Block
userInGroup("Administrators", "557058:950f9f5b-3d6d-4e1d-954a-21367ae9ac75");

Returns "true" if the user with this key is included in Administrators group and "false" if the user with this key is not included in Administrators group.

Example 3

Code Block
userInGroup("Users", currentUser());

Returns: True if the current user is included in "Users" group or False if the current user is not included in "Users" group.

Example

...

4

Code Block
string[] groups = {"Administrators", "Users"};
userInGroup(groups, currentUser());

Returns: True Returns "true" if the current user is included in "Users" or "Administrators" group, or False in Users or Administrators  group and "false" if the current user is not included neither in "Users" nor in "Administrators" groupUsers nor in Administrators group.

Notes

Note

The On the server the look-up is first made after the userkey, then after the username. On cloud the look-up is made only after the userkey.

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "jira_group_routine"
labelsjira_group_routine