User Group Memberships
Quick Navigation
- GET Users/{userID}/UserGroups
- POST Users/{userID}/UserGroups/{userGroupID}
- DELETE Users/{userID}/UserGroups/{userGroupID}
GET Users/{userID}/UserGroups
Purpose
Returns the user group memberships for an existing user.
Required Permissions
User Accounts Management (Read).
URL Parameters
userID: ID of the user.
Request Body
None.
Response Body
Content-Type: application/json
[ { GroupID : int, Name : string, DistinguishedName : string, GroupType : string, AccountAttribute : string, MembershipAttribute : string, IsActive : bool }, … ]
Response Codes
200 – Request successful. User group in the response body.
For more information, please see Common Response Codes.
POST Users/{userID}/UserGroups/{userGroupID}
Purpose
Adds an existing user to a user group.
Required Permissions
User Accounts Management (Read/Write).
URL Parameters
- userID: ID of the user.
- userGroupID: ID of the user group.
Request Body
None.
Response Body
Content-Type: application/json
{ GroupID : int, Name : string, DistinguishedName : string, GroupType : string, AccountAttribute : string, MembershipAttribute : string, IsActive : bool }
Response Codes
201 – Request successful. User group in the response body.
For more information, please see Common Response Codes.
DELETE Users/{userID}/UserGroups/{userGroupID}
Purpose
Removes a user from a user group.
Required Permissions
User Accounts Management (Read/Write).
URL Parameters
- userID: ID of the user.
- userGroupID: ID of the user group.
Request Body
None.
Response Codes
200 – Request successful.
For more information, please see Common Response Codes.