Read user group

Request

This endpoint returns user group information for given group ID.

Security

Bearer

Path

companyIdstring, (uuid)required

Company ID of the user group.

Example:1234a66b-7493-4f41-908c-58ba81093653

groupIdstring, (uuid)required

Identifier for the user group.

Example:4974a66b-7493-4f41-908c-58ba81093947

curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/1234a66b-7493-4f41-908c-58ba81093653/user-groups/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

idstring, (uuid)required

User group identifier.

Example:"4974a66b-7493-4f41-908c-58ba81093947"

namestringrequired

Name of the user group.

Example:"Company Admins"

descriptionstringrequired

A description of the user group.

Example:"Group for managing the company settings."

companyIdstring, (uuid)required

Company ID of the user group.

Example:"1234a66b-7493-4f41-908c-58ba81093653"

createdAtobject(DateTimeOffset)required

Date and time when the user group was created.

updatedAtobject(DateTimeOffset)required

Date and time when the user group was last updated.

createdByobject(Reference object containing uuid and name of the entity.)required

User who created the user group.

updatedByobject(Reference object containing uuid and name of the entity.)required

User who last updated the user group.

isUnmodifiableboolean

Whether the group is not modifiable. This would be set true only for platform created groups. Only group name, description and assigned roles & scopes can not be modified but members can still be updated.

Default:false

platformGroupTypestring(PlatformGroupType)

Type of the platform created group. Set only for platform created groups and absent for custom groups.

Enum:"COMPANY_ADMIN""COMPANY_TRAVEL_ARRANGER""TMC_ADMIN""TMC_AGENT""GLOBAL_ADMIN""GLOBAL_AGENT"

Example:"COMPANY_ADMIN"

Response

{
  "id": "4974a66b-7493-4f41-908c-58ba81093947",
  "name": "Company Admins",
  "description": "Group for managing the company settings.",
  "companyId": "1234a66b-7493-4f41-908c-58ba81093653",
  "createdAt": {
    "iso8601": "2017-07-21T17:32Z"
  },
  "updatedAt": {
    "iso8601": "2017-07-21T17:32Z"
  },
  "createdBy": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "updatedBy": {
    "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3",
    "name": "Name"
  },
  "isUnmodifiable": false,
  "platformGroupType": "COMPANY_ADMIN"
}