Check a user is a member of a group
Log in to add to favouritesHEAD/api/security/groups/{groupIdentifier}/users/{userIdentifier}
Parameters
Name | Parameter type | Type | Format | Description |
---|---|---|---|---|
groupIdentifier(required) | path | string | group identifier | For convenience, Group resources can be referenced by using either the group name or id |
UserIdentifier(required) | path | string | user identifier | For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id. |
Responses
Examples
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/tdurden@fightclub.com
Remarks
Membership will be classed as true if the user is a member of a child group of the specified group.
Permissions
Member of System Administrators
or the authenticated user matching the specified user can check group membership.