Get group membership for a user
Log in to add to favouritesPage last updated 17 June 2022
GET/api/security/users/{userIdentifier}/groups
Parameters
| Name | Parameter type | Type | Format | Description |
|---|---|---|---|---|
| UserIdentifier(required) | path | string | user identifier | For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id. |
| order | query | string | - | A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order. |
| pageIndex | query | number | integer | The index of the page. |
| pageSize | query | number | integer | The number of results per page. The default is 25. |
| includeInherited(required) | query | boolean | - | A flag to determine whether groups a user is implicitly a member of by child groups relationships should also be returned. The default is false. |
Responses
Examples
GET: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/groups?includeInherited=trueGET: /api/security/users/tdurden/groups?includeInherited=trueGET: /api/security/users/t.durden@fightclub.com/groups?includeInherited=trueRemarks
Permissions
Members of System Administrators are permitted to get the groups for any user.
Authenticated standard user accounts are permitted to get their own groups.