User group cache data (groups_caches)

Table of Contents

Requests
- Getting the list of objects with user group cache data
- Retrieving a user group cache data object

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/domain/groups_caches`	Getting the list of objects with user group cache data
`GET`	`/rest/v1/domain/groups_caches/<id>`	Retrieving a user group cache data object

GET

/rest/v1/domain/groups_caches

Getting the list of objects with user group cache data

GET

/rest/v1/domain/groups_caches/<id>

Retrieving a user group cache data object

Getting the list of objects with user group 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_parents, direct_children, direct_users, direct_roles, deep_parents, deep_children, deep_users, 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/groups_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_children": [],
    "deep_parents": [
      "65413330-0180-2d08-e626-7cd30a921f58",
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "deep_roles": [
      "aaarole",
      "ccc2role",
      "cccrole",
      "dddrole"
    ],
    "deep_users": [
      "00000001-1234-1234-1234-123412341234"
    ],
    "direct_children": [],
    "direct_parents": [
      "65413330-0180-2d08-e626-7cd30a921f58",
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "direct_roles": [
      "aaarole"
    ],
    "direct_users": [
      "00000001-1234-1234-1234-123412341234"
    ],
    "id": "0c355641-0180-2cf1-71fb-7cd30a921f58"
  },
  {
    "deep_children": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58",
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "deep_parents": [
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "deep_roles": [
      "ccc2role",
      "cccrole",
      "dddrole"
    ],
    "deep_users": [
      "00000001-1234-1234-1234-123412341234",
      "00000002-1234-1234-1234-123412341234",
      "00000003-1234-1234-1234-123412341234"
    ],
    "direct_children": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58",
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "direct_parents": [
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "direct_roles": [
      "ccc2role",
      "cccrole"
    ],
    "direct_users": [
      "00000003-1234-1234-1234-123412341234"
    ],
    "id": "65413330-0180-2d08-e626-7cd30a921f58"
  },
  {
    "deep_children": [],
    "deep_parents": [
      "65413330-0180-2d08-e626-7cd30a921f58",
      "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
    ],
    "deep_roles": [
      "bbb2role",
      "bbbrole",
      "ccc2role",
      "cccrole",
      "dddrole"
    ],
    "deep_users": [
      "00000002-1234-1234-1234-123412341234"
    ],
    "direct_children": [],
    "direct_parents": [
      "65413330-0180-2d08-e626-7cd30a921f58"
    ],
    "direct_roles": [
      "bbb2role",
      "bbbrole"
    ],
    "direct_users": [
      "00000002-1234-1234-1234-123412341234"
    ],
    "id": "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
  },
  {
    "deep_children": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58",
      "65413330-0180-2d08-e626-7cd30a921f58",
      "c1c6b5b7-0180-2cf2-397d-7cd30a921f58"
    ],
    "deep_parents": [],
    "deep_roles": [
      "dddrole"
    ],
    "deep_users": [
      "00000001-1234-1234-1234-123412341234",
      "00000002-1234-1234-1234-123412341234",
      "00000003-1234-1234-1234-123412341234"
    ],
    "direct_children": [
      "0c355641-0180-2cf1-71fb-7cd30a921f58",
      "65413330-0180-2d08-e626-7cd30a921f58"
    ],
    "direct_parents": [],
    "direct_roles": [
      "dddrole"
    ],
    "direct_users": [],
    "id": "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
  }
]

Retrieving a user group 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/groups_caches/0c355641-0180-2cf1-71fb-7cd30a921f58 HTTP/1.1

Response

Field Description: group_caches entity

Response example

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

{
  "id": "0c355641-0180-2cf1-71fb-7cd30a921f58",
  "direct_children": [],
  "direct_parents": [
    "65413330-0180-2d08-e626-7cd30a921f58",
    "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
  ],
  "direct_roles": [
    "aaarole"
  ],
  "direct_users": [
    "00000001-1234-1234-1234-123412341234"
  ],
  "deep_children": [],
  "deep_parents": [
    "65413330-0180-2d08-e626-7cd30a921f58",
    "ebf06e52-0180-2d4d-87d1-7cd30a921f58"
  ],
  "deep_roles": [
    "aaarole",
    "ccc2role",
    "cccrole",
    "dddrole"
  ],
  "deep_users": [
    "00000001-1234-1234-1234-123412341234"
  ]
}