AVavionte
Users

Get User Groups

Returns a list of configured user groups for the tenant.

get/v1/user/user-groups

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/user/user-groups
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

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.

Response

The list of configured user groups for the specified tenant.

groupIdinteger

The identifier for the user group.

groupNamestring

The name of the user group.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.