Get role

Request

This endpoint returns role details for given role ID.

Security

Bearer

Path

roleIdstring, (uuid)required

Identifier for role.

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

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

Responses

OK

Bodyapplication/json

idstring, (uuid)required

Role identifier.

namestringrequired

Name of the role.

Example:"User Admin"

descriptionstringrequired

A short description of the role mentioning what can it do.

Example:"Manage users for the company."

isPlatformRolebooleanrequired

Whether role is platform provided.

Default:false

Example:false

companyIdstring, (uuid)

Company ID which owns the role.

Example:"1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"

permissionsArray of objects(PermissionWithActions)required

Permissions granted to the role.

createdAtobject(DateTimeOffset)required

Date and time when the role was created.

updatedAtobject(DateTimeOffset)required

Date and time when the role was last updated.

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

User who created the role.

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

User who last updated the role.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "User Admin",
  "description": "Manage users for the company.",
  "isPlatformRole": false,
  "companyId": "1aeef911-44cf-49bb-83c7-e06b0d4e7ac2",
  "permissions": [
    { … }
  ],
  "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"
  }
}