addUsersToGroup
assignPersonaToGroup
createGroup
deleteGroup
getGroup
Retrieve a group by name.
Arguments
Argument Name | Type | Description |
---|---|---|
groupName | String | Name of the group; must be unique among local groups. (Required) |
providerName | String | The name of the provider from which to get the group. |
traverseHierarchy | Boolean | Set to 0 or true to include nested groups in the result if this is an LDAP group and recursive traversal of group hierarchy is enabled for the directory provider. |
getGroups
Retrieve all groups.
Arguments
Argument Name | Type | Description |
---|---|---|
filter | String | Apply a glob-style filter (e.g. 'foo*') when looking for users or groups. |
includeAll | Boolean | Whether to include all users or groups, or only users or groups that are known to the system. |
maximum | Integer | The maximum number of users or groups to return. |
sortOrder | String | Which order to sort in |
modifyGroup
Modify an existing group.
Arguments
Argument Name | Type | Description |
---|---|---|
groupName | String | Name of the group; must be unique among local groups. (Required) |
clearPersonas | Boolean | clear personas for group, if modifying. |
migrateSettings | String | New group name to which settings will be migrated. |
newName | String | New name for an existing object that is being renamed. |
personas | String array | List of personas that this group has. |
removeAllUsers | Boolean | True to remove all users from this group. |
userNames | String array | List of users in the group. |