User Groups API

GET /api/user-groups/v1/{user_group_id}/users/excluded

Get users excluded from group

Gets users excluded from given user group

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Query Parameters:
 
  • search (string) – Search phrase for searching users by email or user id
  • sort (string) – Sort field - can be reversed by adding dash before field name e.g (-email)
  • limit (string) – Limits the number of returned items
  • offset (string) – Sets offset for list of items
Status Codes:
GET /api/user-groups/v1/{user_group_id}/users

Get user group members

Gets user group members

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Query Parameters:
 
  • search (string) – Search phrase for searching users by email or user id
  • sort (string) – Sort field - can be reversed by adding dash before field name e.g (-email)
  • limit (string) – Limits the number of returned items
  • offset (string) – Sets offset for list of items
Status Codes:
GET /api/user-groups/v1/{user_group_id}

Get user group

Gets specific user group details

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Status Codes:
PATCH /api/user-groups/v1/{user_group_id}

Edit user group

Updates user group details

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Status Codes:
DELETE /api/user-groups/v1/{user_group_id}

Delete user group

Deletes user group

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Status Codes:
POST /api/user-groups/v1/{user_group_id}/permissions

Set permission group

Sets permission group to entity for user group

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Status Codes:
POST /api/user-groups/v1

Add user group

Adds user group with unique name

Status Codes:
GET /api/user-groups/v1

List user groups

Lists user groups

Query Parameters:
 
  • search (string) – Search phrase - search for user group name and user group id
  • sort (string) – Sort field - can be reversed by adding dash before field name e.g (-name)
  • limit (string) – Limits the number of returned user groups in response
  • offset (string) – Sets offset for list of user groups in response
Status Codes:
POST /api/user-groups/v1/{user_group_id}/relationships/users

Add users to user group

Adds users to user group

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Status Codes:
DELETE /api/user-groups/v1/{user_group_id}/relationships/users

Remove users from user group

Remove users from user group

Parameters:
  • user_group_id (string) – UUIDv4 identifier of given user group
Status Codes: