Skip to main content

Get group membership for a user

Log in to add to favourites
GET/api/security/users/{userIdentifier}/groups

Parameters

NameParameter typeTypeFormatDescriptionExampleRequired
UserIdentifierpathstringuser identifierFor 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
orderquerystringA comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.-version.modifiedfalse
pageIndexquerynumberintegerThe index of the pagefalse
pageSizequerynumberintegerThe number of results per page. The default is 25.false
includeInheritedquerybooleanA 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

Responses

HTTP status codeReasonModel
200SuccessGroup
401UnauthorizedError
403ForbiddenError
404User not foundError
500Internal server errorError

Examples

HTTP
1
GET: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c/groups?includeInherited=true
HTTP
1
GET: /api/security/users/tdurden/groups?includeInherited=true
HTTP
1
GET: /api/security/users/t.durden@fightclub.com/groups?includeInherited=true

Remarks

Still need help?

New support request