Create endpoint-to-action mapping

Create a new mapping between an API endpoint pattern and an action.

Authorization: Requires admin privileges to create mappings.

Path Patterns: Support exact paths and parameterized paths using curly braces (e.g., /api/v1/users/{user_id}, /api/v1/groups/{group_name}/members).

Method Mapping: Each combination of path pattern and HTTP method can only be mapped to one action.

Action Reference: The action must exist before creating a mapping. Use the actions API to create actions first.

Use Cases:

• Configure authorization for new API endpoints
• Map existing endpoints to granular permissions
• Set up fine-grained access control
• Administrative configuration of API security

Authorizations

Authorization · string · header · required

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

Body

application/json

Request model for creating a new endpoint-to-action mapping.

path_pattern · string · required

URL path pattern (supports wildcards and path parameters)

Required string length: 1 - 255

Example:

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

method · string · required

HTTP method

Example:

"GET"

action_id · integer · required

ID of the action to map to this endpoint

Required range: x > 0

Example:

1

description · string | null

Optional description of this mapping

Maximum length: 500

Example:

"Get user profile information"

Response

201

application/json

Mapping created successfully

Detailed response model for mapping information.

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"