Availability
This routine is available starting with SIL Engine™ 4.5.6.
Syntax
admAddGroupsToGroup(groupsToJoin, childNames)
Alias
addGroupsToGroup(groupsToJoin, childNames)
Description
Add the provided groups to the specified groups if they are not already added.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
| Groups to join | Array of strings | Yes | Group names that the child group should be added to. |
| Child names | Array of strings | Yes | Child names that identifies the child groups to be added to the groups. |
Return type
boolean
Returns "true" if operation succeeded.
Example 1
admAddGroupsToGroup("ParentGroup", "ChildGroup");
Result: The "ChildGroup will be added as child to the "ParentGroup".
Example 2
admAddGroupsToGroup({"Group1","Group2","Group3"}, {"Child1","Child2"});
Result: "Child1", "Child2" will be added as child groups for "Group1","Group2","Group3".
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