Skip to main content
Browse Documentation
HTTP - Management

Check a user is a member of a group

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

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

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



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 ""true


Check if a user is a member of the a group by Id

HEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/9f02a3d1-d8eb-4b10-8ed6-293a11d5201f

Check if user 'tdurden' is a member of the 'Paper Street Soap Company' group by name

HEAD: /api/security/groups/Paper%20Street%20Soap%20Company/users/tdurden

Check if user is a member of the 'Fight club' group by email address

HEAD: /api/security/groups/9bb89380-fd49-41a5-ab2f-fc25e482a251/users/


Membership will be classed as true if the user is a member of a child group of the specified group.


Member of System Administrators or the authenticated user matching the specified user can check group membership.


HTTP status codeReasonModel
204Success - User in Group
404User not in groupError
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.