User cache data (users_caches)

Table of Contents

Requests

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/domain/users_caches`	Getting the list of objects with user cache data
`GET`	`/rest/v1/domain/users_caches/<id>`	Retrieving user cache data object
`PATCH`	`/rest/v1/domain/users_caches/<id>`	Changing the data object of user caches

GET

/rest/v1/domain/users_caches

Getting the list of objects with user cache data

GET

/rest/v1/domain/users_caches/<id>

Retrieving user cache data object

PATCH

/rest/v1/domain/users_caches/<id>

Changing the data object of user caches

Getting the list of objects with user 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_roles, deep_groups, deep_roles.
`offset`	`int`	Offset in the list of resources to be issued.
`limit`	`int`	The maximum number of resources in the list.
`order`	`array<object\|str>`	The sort order of the resources in the list.
`flat`	`bool`	Conversion to flat form of composite fields.

Details about the format of GET request parameters

Request example

GET /rest/v1/domain/users_caches?offset=0&limit=4 HTTP/1.1

Response

Field Description: group_caches entity

Response example

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

[
  {
    "deep_groups": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58",
      "65413330-0180-2d08-e626-7cd30a921f58",
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "deep_roles": [
      "aaarole",
      "ccc2role",
      "cccrole",
      "dddrole",
      "test",
      "user"
    ],
    "direct_groups": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58"
    ],
    "direct_roles": [
      "test",
      "user"
    ],
    "id": "00000001-1234-1234-1234-123412341234"
  },
  {
    "deep_groups": [
      "65413330-0180-2d08-e626-7cd30a921f58",
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58",
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "deep_roles": [
      "bbb2role",
      "bbbrole",
      "ccc2role",
      "cccrole",
      "dddrole",
      "test",
      "user"
    ],
    "direct_groups": [
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "direct_roles": [
      "test",
      "user"
    ],
    "id": "00000002-1234-1234-1234-123412341234"
  },
  {
    "deep_groups": [
      "65413330-0180-2d08-e626-7cd30a921f58",
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "deep_roles": [
      "ccc2role",
      "cccrole",
      "dddrole",
      "test",
      "user"
    ],
    "direct_groups": [
      "65413330-0180-2d08-e626-7cd30a921f58"
    ],
    "direct_roles": [
      "test",
      "user"
    ],
    "id": "00000003-1234-1234-1234-123412341234"
  },
  {
    "deep_groups": [],
    "deep_roles": [
      "test",
      "user"
    ],
    "direct_groups": [],
    "direct_roles": [
      "test",
      "user"
    ],
    "id": "00000004-1234-1234-1234-123412341234"
  }
]

Retrieving user cache data object

Request

Table 2. Request parameters
Name	Type	Description
`mask`	`str`	A list of fields to output.
`flat`	`bool`	Conversion to flat form of composite fields.

Request example

GET /rest/v1/domain/users_caches/00000001-1234-1234-1234-123412341234 HTTP/1.1

Response

Field Description: group_caches entity

Response example

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

{
  "id": "00000001-1234-1234-1234-123412341234",
  "direct_groups": [
    "0c355641-0180-2cf1-71fb-7cd30a921f58"
  ],
  "direct_roles": [
    "test",
    "user"
  ],
  "deep_groups": [
    "0c355641-0180-2cf1-71fb-7cd30a921f58",
    "65413330-0180-2d08-e626-7cd30a921f58",
    "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
  ],
  "deep_roles": [
    "aaarole",
    "ccc2role",
    "cccrole",
    "dddrole",
    "test",
    "user"
  ]
}

Changing the data object of user caches

Fields prohibited for modification: id

Request

Field Description: group_caches entity

Request example

PATCH /rest/v1/domain/users_caches/00000001-1234-1234-1234-123412341234 HTTP/1.1
Content-Type: application/json; charset=utf-8

group_caches entity

Response

Field Description: group_caches entity

Response example

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

{
  "id": "00000001-1234-1234-1234-123412341234",
  "direct_groups": [
    "0c355641-0180-2cf1-71fb-7cd30a921f58",
    "37b02e82-1520-a943-0ff7-19c037b1258a"
  ]
}