Role cache data (roles_caches)

Requests

HTTP verb Endpoint Description

GET

/rest/v1/domain/roles_caches

Getting the list of objects with user role cache data

GET

/rest/v1/domain/roles_caches/<id>

Getting a user role cache data object


Getting the list of objects with user role cache data

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, direct_groups, direct_users, deep_groups, deep_users.

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_caches?offset=0&limit=4 HTTP/1.1

Response

Field description: group_caches entity

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

[
  {
    "deep_groups": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58"
    ],
    "deep_users": [
      "00000001-1234-1234-1234-123412341234"
    ],
    "direct_groups": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58"
    ],
    "direct_users": [],
    "name": "aaarole"
  },
  {
    "deep_groups": [],
    "deep_users": [
      "0151a875-017d-dd8e-2564-7cd30a921f58",
      "4f189a7d-0a01-bc9d-95c1-b7fcd2346135",
      "e7adf0aa-05b7-8163-948c-275d40f7b205",
      "e7adf0aa-05b7-8163-948c-3392a9660db9"
    ],
    "direct_groups": [],
    "direct_users": [
      "0151a875-017d-dd8e-2564-7cd30a921f58",
      "4f189a7d-0a01-bc9d-95c1-b7fcd2346135",
      "e7adf0aa-05b7-8163-948c-275d40f7b205",
      "e7adf0aa-05b7-8163-948c-3392a9660db9"
    ],
    "name": "admin"
  },
  {
    "deep_groups": [
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "deep_users": [
      "00000002-1234-1234-1234-123412341234"
    ],
    "direct_groups": [
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "direct_users": [],
    "name": "bbb2role"
  },
  {
    "deep_groups": [
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "deep_users": [
      "00000002-1234-1234-1234-123412341234"
    ],
    "direct_groups": [
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "direct_users": [],
    "name": "bbbrole"
  }
]

Getting a user role cache data object

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_caches/aaarole HTTP/1.1

Response

Field description: group_caches entity

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

{
  "name": "aaarole",
  "direct_groups": [
    "0c355641-0180-2cf1-71fb-7cd30a921f58"
  ],
  "direct_users": [],
  "deep_groups": [
    "0c355641-0180-2cf1-71fb-7cd30a921f58"
  ],
  "deep_users": [
    "00000001-1234-1234-1234-123412341234"
  ]
}