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

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
order	query	string		A comma-separated list of the field Ids to order the results by. Prefix field Id with - for descending order.	-version.modified	false
pageIndex	query	number	integer	The index of the page		false
pageSize	query	number	integer	The number of results per page. The default is 25.		false
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

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

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.