v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Users

Get User Groups

Returns a list of configured user groups for the tenant.

get/v1/user/user-groups

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

The list of configured user groups for the specified tenant.

groupIdinteger

The identifier for the user group.

groupNamestring

The name of the user group.

[
  {
    "groupId": 284,
    "groupName": "Administrators"
  }
]