Skip to main content
Browse Documentation
HTTP - Management

Check a user is a member of a group

Created by c.neale, last modified by s.yearsley on 24 Sep 2020

A user can be checked to see if it is a member of a specific group, or groups, using the following HEAD request. A 204 HTTP status response confirms membership, whereas a 404 HTTP status marks no membership.

Multiple groups can be specified using a CSV of GroupIdentifiers.

If an invalid value for userIdentifier or any groupIdentifier is passed then a 400 HTTP status response will be returned.

HEAD/api/security/users/{userIdentifier}/groups/{groupIdentifier}[ ,...n ]

Parameters

NameParameter typeTypeFormatDescriptionExampleRequired
groupIdentifierpathstringgroup identifierFor convenience, Group resources can be referenced by using either the group name or id"Paper Street Soap Company" or "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c"true
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

Examples

Single GroupId

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

Csv of GroupId Values

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
HEAD: /api/security/users/tdurden/groups/0ccf6d37-56a2-4a0d-bda1-efc377369232,eee2ca1a-8736-48b7-a274-da6f35499e56,504f21d0-361c-4c56-a87c-25e24ea81dfc
HEAD: /api/security/users/tdurden/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251
HEAD: /api/security/users/t.durden@fightclub.com/groups/Paper%20Street%20Soap%20Company,Liposuction%20Technicians
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.

Responses

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