Skip to content
4HSE

CacheAbility

Manage cache abilities, which represent cached permissions and roles for users and entities.
You can search for cache abilities with advanced filtering and pagination.

Version
2.0.0
OpenAPI version
3.0.0

Operations

Section titled “Operations”

index

Section titled “index”
POST
/v2/cache-ability/index

Returns a paginated and filterable list of cache abilities.
Use POST to allow complex filters via JSON payload.

Request Body

Section titled “Request Body ”

Parameters for searching cache abilities

object
filter
object
ability_id
string format: uuid
user_id
string
<= 50 characters
user_status
string
<= 50 characters
entity_id
string
<= 50 characters
entity_type
string
<= 50 characters
entity_name
string
<= 255 characters
first_name
string
<= 70 characters
last_name
string
<= 70 characters
permission
string
<= 255 characters
inherited
boolean
weight
integer
principal
boolean
per-page
integer
default: 100 >= 1
page
integer
default: 1 >= 1
sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string
history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean
Example
{
  "filter": {
    "user_id": "user-1",
    "entity_type": "PROJECT"
  },
  "per-page": 10,
  "page": 1,
  "sort": "entity_name"
}

Responses

Section titled “ Responses ”
200
Section titled “200 ”

List of cache abilities

Array<object>
object
ability_id
string format: uuid
user_id
string
<= 50 characters
user_status
string
<= 50 characters
entity_id
string
<= 50 characters
entity_type
string
<= 50 characters
entity_name
string
<= 255 characters
first_name
string
<= 70 characters
last_name
string
<= 70 characters
permission
string
<= 255 characters
inherited
boolean
weight
integer
principal
boolean
Example
{
  "ability_id": "abc123",
  "user_id": "user-1",
  "user_status": "active",
  "entity_id": "proj-1",
  "entity_type": "PROJECT",
  "entity_name": "Project Alpha",
  "permission": "read",
  "inherited": false,
  "weight": 1,
  "principal": true
}

Headers

Section titled “Headers ”
X-Pagination-Current-Page
integer

Current page

X-Pagination-Page-Count
integer

Total number of pages

X-Pagination-Per-Page
integer

Number of items per page

X-Pagination-Total-Count
integer

Total number of items