Skip to main content
GET
/
api
/
v1
/
mappings
/
list
List all endpoint mappings
curl --request GET \
  --url https://services.pref.rio/heimdall-admin/api/v1/mappings/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "path_pattern": "/api/v1/users/{user_id}",
    "method": "GET",
    "action": "user:read",
    "description": "Get user profile information",
    "created_by": "12345678901",
    "created_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "path_pattern": "/api/v1/groups",
    "method": "POST",
    "action": "group:create",
    "description": "Create new group",
    "created_by": "12345678901",
    "created_at": "2024-01-15T11:00:00Z",
    "updated_at": "2024-01-16T09:15:00Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
action_filter
string | null

Filter mappings by specific action name (exact match)

Response

Mappings retrieved successfully

​
id
integer
required

Unique identifier of the mapping

Example:

1

​
path_pattern
string
required

URL path pattern

Example:

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

​
method
string
required

HTTP method

Example:

"GET"

​
action
string
required

Action name

Example:

"user:read"

​
created_at
string
required

ISO timestamp when the mapping was created

Example:

"2024-01-15T10:30:00Z"

​
description
string | null

Mapping description

Example:

"Get user profile information"

​
created_by
string | null

CPF of the user who created this mapping

Example:

"12345678901"

​
updated_at
string | null

ISO timestamp when the mapping was last updated

Example:

"2024-01-16T14:20:00Z"