> ## 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.

# Create Role

> Create a role (admin-only).
Implements POST /roles as specified in SPEC.md Section 3.4.



## OpenAPI

````yaml https://raw.githubusercontent.com/prefeitura-rio/heimdall/main/docs/api/openapi.json post /api/v1/roles/
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/roles/:
    post:
      tags:
        - roles
      summary: Create Role
      description: |-
        Create a role (admin-only).
        Implements POST /roles as specified in SPEC.md Section 3.4.
      operationId: create_role_api_v1_roles__post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    RoleCreateRequest:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          pattern: ^[a-z0-9_:]+$
          title: Name
          description: >-
            Unique name for the role (lowercase letters, numbers, underscores,
            and colons only)
          example: data_analyst:read
        description:
          type: string
          maxLength: 500
          minLength: 1
          title: Description
          description: Human-readable description of the role's purpose and permissions
          example: Data analysts with read access to analytics dashboards
      type: object
      required:
        - name
        - description
      title: RoleCreateRequest
      description: Request model for creating a new role.
      example:
        description: Data analysts with read access to analytics dashboards
        name: data_analyst:read
    RoleResponse:
      properties:
        id:
          type: integer
          title: Id
          description: Unique identifier for the role
          example: 1
        name:
          type: string
          title: Name
          description: Role name
          example: data_analyst:read
        description:
          type: string
          title: Description
          description: Role description
          example: Data analysts with read access to analytics dashboards
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: CPF of the user who created this role (null for system roles)
          example: '12345678901'
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
          description: ISO timestamp when the role was created (null for system roles)
          example: '2024-01-15T10:30:00Z'
      type: object
      required:
        - id
        - name
        - description
      title: RoleResponse
      description: Response model for role information.
      example:
        created_at: '2024-01-15T10:30:00Z'
        created_by: '12345678901'
        description: Data analysts with read access to analytics dashboards
        id: 1
        name: data_analyst:read
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````