Skip to main content
GET
/
api
/
v1
/
actions
/
List all actions
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/actions/ \
  --header 'Authorization: Bearer <token>'
{
  "actions": [
    {
      "id": 1,
      "name": "user:read",
      "description": "Read user information",
      "endpoint_count": 3
    },
    {
      "id": 2,
      "name": "group:create",
      "description": "Create new groups",
      "endpoint_count": 1
    }
  ],
  "total": 25,
  "skip": 0,
  "limit": 50
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
skip
integer
default:0

Number of actions to skip (pagination offset)

Required range: x >= 0
​
limit
integer
default:50

Maximum number of actions to return

Required range: 1 <= x <= 100

Response

Actions retrieved successfully

Response model for paginated action lists.

​
actions
ActionResponse · object[]
required

List of actions for the current page

​
total
integer
required

Total number of actions in the system

Example:

25

​
skip
integer
required

Number of actions skipped (pagination offset)

Example:

0

​
limit
integer
required

Maximum number of actions per page

Example:

50