Skip to main content
GET
/
api
/
v1
/
mappings
Resolve endpoint to action
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/mappings/ \
  --header 'Authorization: Bearer <token>'
{
  "mapping_id": 1,
  "action": "user:read",
  "path_pattern": "/api/v1/users/{user_id}",
  "method": "GET",
  "description": "Get user profile information"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
path
string
required

The API path to resolve (e.g., '/api/v1/users/123')

​
method
string
required

The HTTP method

Response

MappingResponse · object | null

Mapping found and resolved successfully

Response model for mapping resolution (used by authorization middleware).

​
mapping_id
integer
required

Unique identifier of the mapping

Example:

1

​
action
string
required

Action name mapped to this endpoint

Example:

"user:read"

​
path_pattern
string
required

URL path pattern that matched

Example:

"/api/v1/users/{user_id}"

​
method
string
required

HTTP method

Example:

"GET"

​
description
string | null

Mapping description

Example:

"Get user profile information"