Introdução

Busca

Catálogo

Subpav OSA SMS

eAi Agent

Registro Municipal Integrado

GO

Encurtador de URLs

Surkai

Heimdall API

Update action

curl --request PUT \
  --url https://services.pref.rio/heimdall-admin/api/v1/actions/{action_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Read user information and profile data",
  "name": "user:read"
}
'

{
  "id": 1,
  "name": "user:read",
  "description": "Read user information and profile data",
  "endpoint_count": 3
}

actions

Update action

Update an existing action’s name and/or description.

Authorization: Requires admin privileges to update actions.

Partial Updates: You can update just the name, just the description, or both. Provide only the fields you want to update.

Impact: Updating an action name may affect existing endpoint mappings and authorization policies that reference this action.

Use Cases:

Refine action descriptions for better clarity
Rename actions to follow updated naming conventions
Administrative maintenance of the action catalog

PUT

api

actions

{action_id}

Update action

curl --request PUT \
  --url https://services.pref.rio/heimdall-admin/api/v1/actions/{action_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Read user information and profile data",
  "name": "user:read"
}
'

{
  "id": 1,
  "name": "user:read",
  "description": "Read user information and profile data",
  "endpoint_count": 3
}

Authorizations

Authorization

string

header

required

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

Path Parameters

action_id

integer

required

Body

application/json

Request model for updating an existing action.

name

string | null

Updated name for the action

Required string length: 1 - 100

Pattern: ^[a-zA-Z0-9_:-]+$

Example:

"user:read"

description

string | null

Updated description of the action's purpose

Required string length: 1 - 500

Example:

"Read user information and profile data"

Response

Action updated successfully

Response model for action information.

integer

required

Unique identifier for the action

Example:

1

name

string

required

Action name

Example:

"user:read"

description

string | null

Action description

Example:

"Read user information"

endpoint_count

integer

default:0

Number of API endpoints mapped to this action

Example:

3

Get action by ID Delete action