Skip to main content
Browse Documentation
HTTP - Management

Get group membership for a user

Created by c.neale, last modified by zengenti on 17 Jun 2022

Gets the groups the user is a member of.

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

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

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.

Responses

HTTP status codeReasonModel
200SuccessPagedList<Group>
401UnauthorizedError
403ForbiddenError
404User not foundError
500Internal server errorError
Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.