User roles (roles)

Requests

HTTP verb Endpoint Description

POST

/rest/v1/domain/roles

Creating a new user role

GET

/rest/v1/domain/roles

Getting the list of user roles

GET

/rest/v1/domain/roles/<id>

Getting user role data

PATCH

/rest/v1/domain/roles/<id>

Modifying user role data

DELETE

/rest/v1/domain/roles/<id>

Deleting a user role

LOOKUP

/rest/v1/domain/roles

Searching for a user role identifier


Creating a new user role

Request

Field description: role entity

Example request
POST /rest/v1/domain/roles HTTP/1.1
Content-Type: application/json; charset=utf-8

role entity

Response

Field description: role entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "name": "testrole",
  "description": "",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "routes": [
    {
      "methods": [ "*" ],
      "url": "/rest/v1/model/abc/def"
    },
    {
      "methods": [ "GET", "LOOKUP" ],
      "url": "/rest/v1/model/abc/zzzzzzzzz"
    },
    {
      "methods": ["WEBSOCKET"],
      "url": "/ws#rest"
    }
  ],
  "webapps": [],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2021-03-20T10:37:03.82Z",
    "lwt": "2021-03-20T10:41:42.25Z"
  }
}

Getting the list of user roles

Request

Table 1. Request parameters
Name Type Description

filter

object

Filter by field values.

mask

str

List of fields to output. Available fields for output: id, name, description, parent_id, routes, opts.title, opts.comment, ext.lwt, ext.ct.

offset

int

Offset in the list of resources to output.

limit

int

Maximum number of resources in the list.

order

array<object|str>

Sorting order of resources in the list.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/domain/roles?offset=0&limit=2 HTTP/1.1

Response

Field description: role entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
    "name": "testrole",
    "description": "",
    "parent_id": "00000000-0000-0000-0000-000000000000",
    "routes": [
      {
        "methods": [ "" ],
        "url": "/rest/v1/model/abc/def"
      },
      {
        "methods": [ "GET", "LOOKUP" ],
        "url": "/rest/v1/model/abc/zzzzzzzzz"
      },
      {
        "methods": ["WEBSOCKET"],
        "url": "/ws#rest"
      }
    ],
    "webapps": [],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2021-03-20T10:37:03.82Z",
      "lwt": "2021-03-20T10:41:42.25Z"
    }
  },
  {
    "id": "abcdef00-05b7-8163-948c-3392a9660db9",
    "name": "xxx",
    "description": "",
    "parent_id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
    "routes": [
      {
        "methods": [
          "GET"
        ],
        "url": "/rest/v1/uc/*"
      }
    ],
    "webapps": [],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2021-03-22T20:22:25.26Z",
      "lwt": "2021-03-22T20:22:25.26Z"
    }
  }
]

Getting user role data

Request

Table 2. Request parameters
Name Type Description

mask

str

List of fields to output.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/domain/roles/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1

Response

Field description: role entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "name": "testrole",
  "description": "",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "routes": [
    {
      "methods": [ "*" ],
      "url": "/rest/v1/model/abc/def"
    },
    {
      "methods": [ "GET", "LOOKUP" ],
      "url": "/rest/v1/model/abc/zzzzzzzzz"
    },
    {
      "methods": ["WEBSOCKET"],
      "url": "/ws#rest"
    }
  ],
  "webapps": [],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2021-03-20T10:37:03.82Z",
    "lwt": "2021-03-20T10:41:42.25Z"
  }
}

Modifying user role data

Fields prohibited for modification: id

Request

Field description: role entity

Example request
PATCH /rest/v1/domain/roles/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1
Content-Type: application/json; charset=utf-8

role entity

Response

Field description: role entity

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "name": "testrole",
  "description": "",
  "parent_id": "00000000-0000-0000-0000-000000000000",
  "routes": [
    {
      "methods": [ "*" ],
      "url": "/rest/v1/model/abc/def"
    },
    {
      "methods": [ "GET", "LOOKUP" ],
      "url": "/rest/v1/model/abc/zzzzzzzzz"
    },
    {
      "methods": ["WEBSOCKET"],
      "url": "/ws#rest"
    },
    {
      "methods": ["WEBSOCKET"],
      "url": "/ws#subscr"
    }
  ],
  "webapps": [],
  "opts": {
    "title": "",
    "comment": "New comment"
  },
  "ext": {
    "ct": "2021-03-20T10:37:03.82Z",
    "lwt": "2021-03-20T10:41:42.25Z"
  }
}

Deleting a user role

Request

Example request
DELETE /rest/v1/domain/roles/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1

Response

Example response
HTTP/1.1 204 No Content

Searching for a user role identifier

Searches for a resource by the specified key and returns the identifier(s) for building the endpoint.

Key fields for search: id, name

Request

Example request
LOOKUP /rest/v1/domain/roles HTTP/1.1
Content-Type: application/json; charset=utf-8

"testrole"

Response

Example successful response
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "afafafaf-0178-3fc1-67fc-7cd30a921f58"
]
Example failed response
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}