Skip to main content

Get group membership for a user

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

Parameters

NameParameter typeTypeFormatDescription
UserIdentifier(required)pathstringuser identifier For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id.
orderquerystring-A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.
pageIndexquerynumberintegerThe index of the page.
pageSizequerynumberintegerThe number of results per page. The default is 25.
includeInherited(required)queryboolean-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

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

Examples

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

Remarks

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.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request