user groups

A user group is a collection of users with service groups and roles.

Data model

created_atstringDate and time in ISO 8601 format. Read-only.
descriptionstringDescription of the user group.
idstringAlphanumeric string identifying the user group.
invitations_countintegerNumber of invitations added to the user group.
namestringName of the user group.
roles_countintegerNumber of roles added to the user group.
updated_atstringDate and time in ISO 8601 format. Read-only.
users_countintegerNumber of users added to the user group.

Endpoints

List user groups

GET/user-groups

Create a user group

POST/user-groups

Get a user group

GET/user-groups/user_group_id

Delete a user group

DELETE/user-groups/user_group_id

Update a user group

PATCH/user-groups/user_group_id

List roles in a user group

GET/user-groups/user_group_id/roles

Add roles to a user group

POST/user-groups/user_group_id/roles

Remove roles from a user group

DELETE/user-groups/user_group_id/roles

List service groups in a user group

GET/user-groups/user_group_id/service-groups

Add service groups to a user group

POST/user-groups/user_group_id/service-groups

Remove service groups from a user group

DELETE/user-groups/user_group_id/service-groups

List members of a user group

GET/user-groups/user_group_id/members

Add members to a user group

POST/user-groups/user_group_id/members

Remove members of a user group

DELETE/user-groups/user_group_id/members