> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dados.rio/llms.txt
> Use this file to discover all available pages before exploring further.

# List all actions

> Retrieve a paginated list of all actions available in the system.

**Authorization**: All authenticated users can list actions.

**Pagination**: Use `skip` and `limit` parameters to control pagination.
Maximum limit is 100 actions per request.

**Action Information**: Each action includes its name, description, and the
number of API endpoints currently mapped to it.

**Use Cases**:
- Display available actions in administrative interfaces
- Integration with external authorization systems
- Action selection during endpoint mapping configuration
- Audit and compliance reporting
- Permission management workflows



## OpenAPI

````yaml https://raw.githubusercontent.com/prefeitura-rio/heimdall/main/docs/api/openapi.json get /api/v1/actions/
openapi: 3.1.0
info:
  title: Heimdall Admin Service
  description: >-
    # Heimdall Admin Service API


    A comprehensive admin service for user and group management with
    authorization powered by Cerbos.


    ## Features


    - **User Management**: Automatic user creation from JWT tokens with
    role-based access control

    - **Group Management**: Create, manage, and assign users to groups with
    hierarchical permissions

    - **Role Management**: Define and assign roles to users and groups

    - **Mapping Management**: Configure API endpoint to action mappings for
    authorization

    - **Action Management**: Define available actions for fine-grained
    permission control

    - **Cerbos Integration**: Policy-based authorization with external Cerbos
    service

    - **Audit Logging**: Comprehensive audit trail for all administrative
    operations

    - **Redis Caching**: High-performance caching for frequently accessed data
  version: 1.0.0
servers:
  - url: https://services.pref.rio/heimdall-admin
    description: Production server
  - url: https://services.staging.app.dados.rio/heimdall-admin
    description: Staging server
security: []
tags:
  - name: health
    description: Service health and readiness checks
  - name: users
    description: >-
      User management operations. Users are automatically created from JWT
      tokens.
  - name: groups
    description: >-
      Group management operations. Groups organize users and can have roles
      assigned.
  - name: memberships
    description: Group membership management. Assign and remove users from groups.
  - name: roles
    description: >-
      Role management operations. Roles define permissions that can be assigned
      to users or groups.
  - name: actions
    description: >-
      Action management operations. Actions define the granular permissions
      available in the system.
  - name: mappings
    description: >-
      API endpoint to action mapping configuration. Maps HTTP endpoints to
      authorization actions.
paths:
  /api/v1/actions/:
    get:
      tags:
        - actions
      summary: List all actions
      description: >-
        Retrieve a paginated list of all actions available in the system.


        **Authorization**: All authenticated users can list actions.


        **Pagination**: Use `skip` and `limit` parameters to control pagination.

        Maximum limit is 100 actions per request.


        **Action Information**: Each action includes its name, description, and
        the

        number of API endpoints currently mapped to it.


        **Use Cases**:

        - Display available actions in administrative interfaces

        - Integration with external authorization systems

        - Action selection during endpoint mapping configuration

        - Audit and compliance reporting

        - Permission management workflows
      operationId: list_actions_api_v1_actions__get
      parameters:
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Number of actions to skip (pagination offset)
            default: 0
            title: Skip
          description: Number of actions to skip (pagination offset)
          example: 0
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Maximum number of actions to return
            default: 50
            title: Limit
          description: Maximum number of actions to return
          example: 50
      responses:
        '200':
          description: Actions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionListResponse'
              example:
                actions:
                  - id: 1
                    name: user:read
                    description: Read user information
                    endpoint_count: 3
                  - id: 2
                    name: group:create
                    description: Create new groups
                    endpoint_count: 1
                total: 25
                skip: 0
                limit: 50
        '401':
          description: Unauthorized - Invalid or missing JWT token
          content:
            application/json:
              example:
                detail: Could not validate credentials
        '422':
          description: Validation error - Invalid pagination parameters
          content:
            application/json:
              example:
                detail: Validation error
                errors:
                  - loc:
                      - query
                      - limit
                    msg: ensure this value is less than or equal to 100
                    type: value_error.number.not_le
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                detail: 'Failed to list actions: Database connection error'
      security:
        - HTTPBearer: []
components:
  schemas:
    ActionListResponse:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/app__routers__actions__ActionResponse'
          type: array
          title: Actions
          description: List of actions for the current page
        total:
          type: integer
          title: Total
          description: Total number of actions in the system
          example: 25
        skip:
          type: integer
          title: Skip
          description: Number of actions skipped (pagination offset)
          example: 0
        limit:
          type: integer
          title: Limit
          description: Maximum number of actions per page
          example: 50
      type: object
      required:
        - actions
        - total
        - skip
        - limit
      title: ActionListResponse
      description: Response model for paginated action lists.
      example:
        actions:
          - description: Read user information
            endpoint_count: 3
            id: 1
            name: user:read
          - description: Create new groups
            endpoint_count: 1
            id: 2
            name: group:create
        limit: 50
        skip: 0
        total: 25
    app__routers__actions__ActionResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Unique identifier for the action
          example: 1
        name:
          type: string
          title: Name
          description: Action name
          example: user:read
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Action description
          example: Read user information
        endpoint_count:
          type: integer
          title: Endpoint Count
          description: Number of API endpoints mapped to this action
          default: 0
          example: 3
      type: object
      required:
        - id
        - name
      title: ActionResponse
      description: Response model for action information.
      example:
        description: Read user information
        endpoint_count: 3
        id: 1
        name: user:read
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````