HTTP - Management
Get group membership for a user
Created by c.neale, last modified by r.saunders on 12 Feb 2021
Gets the groups the user is a member of.
GET/api/security/users/{userIdentifier}/groups
Parameters
Name | Parameter type | Type | Format | Description | Example | Required |
---|---|---|---|---|---|---|
UserIdentifier | path | string | user identifier | For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id. | "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com" | true |
includeInherited | 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. | true |
Examples
GET: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/groups?includeInherited=true
GET: /api/security/users/tdurden/groups?includeInherited=true
GET: /api/security/users/t.durden@fightclub.com/groups?includeInherited=true