Availability
This routine is available starting with SIL Engine™ 4.5.6.
Syntax
admRemoveGroupFromGroups(groupsToRemoveFrom, childName)
Alias
removeGroupFromGroups(groupsToRemoveFrom, childName)
Description
Add the provided groups to the specified groups if they are not already added.
Parameters
Parameter name | Type | Required | Description |
---|---|---|---|
Groups to remove from | Array of strings | Yes | Group names that the child group should be removed from. |
Child name | String | Yes | Child group to be removed from the parent groups. |
Return type
boolean
Returns "true" if operation succeeded.
Example 1
admRemoveGroupsFromGroups("ParentGroup", "ChildGroup");
Result: The "ChildGroup will be removed from the "ParentGroup".
Example 2
admRemoveGroupsFromGroups({"Group1","Group2"}, "ChildGroup");
Result: The "ChildGroup will be removed from the "Group1" and "Group2".
Notes
In order to allow Jira to handle nested groups you would need first to enable or disable support for nested groups on each directory individually. Select User Directories from the JIRA administration menu, edit the directory and select Enable Nested Groups. See Configuring user directories.
See also