Skip to main content

Check a user is a member of a group

Log in to add to favourites
HEAD/api/security/users/{userIdentifier}/groups/{groupIdentifier}[ ,...n ]

Parameters

NameParameter typeTypeFormatDescription
groupIdentifier(required)pathstringgroup identifier For convenience, Group resources can be referenced by using either the group name or id
UserIdentifier(required)pathstringuser identifier For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id.

Responses

HTTP status codeReasonModel
204Success - User in Group
401UnauthorizedError
403ForbiddenError
404User not in groupError
500Internal server errorError

Examples

Single GroupId

HTTP
HEAD: /api/security/users/9f02a3d1-d8eb-4b10-8ed6-293a11d5201f/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251
HTTP
HEAD: /api/security/users/tdurden/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251
HTTP
HEAD: /api/security/users/t.durden@fightclub.com/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251
HTTP
HEAD: /api/security/users/t.durden@fightclub.com/groups/Paper%20Street%20Soap%20Company

Csv of GroupId Values

HTTP
HEAD: /api/security/users/653aca45-d768-48d4-9af0-435e138b063f/groups/0ccf6d37-56a2-4a0d-bda1-efc377369232,eee2ca1a-8736-48b7-a274-da6f35499e56,504f21d0-361c-4c56-a87c-25e24ea81dfc
HTTP
HEAD: /api/security/users/tdurden/groups/0ccf6d37-56a2-4a0d-bda1-efc377369232,eee2ca1a-8736-48b7-a274-da6f35499e56,504f21d0-361c-4c56-a87c-25e24ea81dfc
HTTP
HEAD: /api/security/users/tdurden/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251
HTTP
HEAD: /api/security/users/t.durden@fightclub.com/groups/Paper%20Street%20Soap%20Company,Liposuction%20Technicians
HTTP
HEAD: /api/security/users/t.durden@fightclub.com/groups/0ccf6d37-56a2-4a0d-bda1-efc377369232,Liposuction%20Technicians

Remarks

Membership will be classed as true if the user is a member of a child group of the specified group. Multiple groupId values can be passed in the path as comma-separated-value (CSV). If a CSV is passed then an OR evaluation will be performed.

 

Permissions

Member of System Administrators.

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