Introdução

Busca

Catálogo

Subpav OSA SMS

eAi Agent

Registro Municipal Integrado

GO

Encurtador de URLs

Surkai

Heimdall API

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
}

actions

List all actions

Retrieve a paginated list of all actions available in the system.

Authorization: All authenticated users can list actions.

Pagination: Use skip and limit parameters to control pagination. Maximum limit is 100 actions per request.

Action Information: Each action includes its name, description, and the number of API endpoints currently mapped to it.

Use Cases:

Display available actions in administrative interfaces
Integration with external authorization systems
Action selection during endpoint mapping configuration
Audit and compliance reporting
Permission management workflows

GET

api

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

Show child attributes

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

Delete a role Create a new action