Skip to main content
PUT
/
api
/
v1
/
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
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.

​
id
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