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

# Create Role

> Creates a role.



## OpenAPI

````yaml /api-reference/bko/openapi.json post /api/v1/bko/roles
openapi: 3.0.0
info:
  title: DEVMOB BKO API
  version: '1.0'
servers: []
security: []
tags:
  - name: Auth
    description: Authentication endpoints.
  - name: Benefit Category
    description: Global fare benefit category endpoints.
  - name: Benefit Program
    description: Platform fare benefit program endpoints.
  - name: Invite
    description: Invitation endpoints.
  - name: Member
    description: BKO internal member endpoints.
  - name: Order
    description: Order query endpoints.
  - name: Organization
    description: Organization management endpoints.
  - name: Organization Address
    description: Organization address endpoints.
  - name: Payment
    description: Payment query endpoints.
  - name: Permission
    description: Permission catalog endpoints.
  - name: Place
    description: Place lookup endpoints.
  - name: Point
    description: Global point catalog endpoints.
  - name: Profile
    description: Authenticated BKO profile endpoints.
  - name: Receivable
    description: Receivable query endpoints.
  - name: Report
    description: Platform report endpoints.
  - name: Role
    description: Internal and reusable role endpoints.
  - name: Storage
    description: Storage upload signing endpoints.
  - name: Transfer
    description: Transfer query endpoints.
  - name: User
    description: Platform user administration endpoints.
paths:
  /api/v1/bko/roles:
    post:
      tags:
        - Role
      summary: Create Role
      description: Creates a role.
      operationId: createRole
      parameters:
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRoleRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: Created
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
        - bearer: []
components:
  schemas:
    CreateRoleRequest:
      type: object
      properties:
        organizationId:
          type: string
          format: uuid
          description: Organization identifier. Required only for ORGANIZATION roles.
          nullable: true
        type:
          type: string
          enum:
            - INTERNAL
            - ENVIRONMENT
            - ORGANIZATION
          description: Role type
        name:
          type: string
          description: Role name
        description:
          type: string
          description: Role description
          nullable: true
        permissions:
          type: array
          items:
            type: string
            enum:
              - access:ops
              - access:bko
              - access:driver
              - read:organization
              - update:organization
              - read:role
              - create:role
              - update:role
              - delete:role
              - read:member
              - create:member
              - update:member
              - delete:member
              - read:invite
              - create:invite
              - delete:invite
              - read:vehicle
              - create:vehicle
              - update:vehicle
              - delete:vehicle
              - read:seat-type
              - read:driver
              - create:driver
              - update:driver
              - delete:driver
              - read:point
              - create:point
              - update:point
              - delete:point
              - read:route
              - create:route
              - update:route
              - delete:route
              - read:bank_account
              - update:bank_account
              - read:payment
              - read:trip
              - create:trip
              - update:trip
              - delete:trip
              - read:trip_schedule
              - create:trip_schedule
              - update:trip_schedule
              - delete:trip_schedule
              - create:trip_event
              - read:order
              - create:order
              - update:order
              - read:ticket
              - create:ticket
              - update:ticket
              - delete:ticket
              - read:balance
              - read:receivable
              - read:transfer
              - create:transfer
              - read:audit
              - read:user
              - update:user
              - read:benefit_category
              - create:benefit_category
              - update:benefit_category
              - delete:benefit_category
              - read:benefit_program
              - create:benefit_program
              - update:benefit_program
              - delete:benefit_program
          description: Granted permissions
      required:
        - type
        - name
        - permissions
      description: Create role payload
    Role:
      type: object
      properties:
        roleId:
          type: string
          format: uuid
          description: Identificador único
        organizationId:
          type: string
          format: uuid
          nullable: true
          description: Referência à organização; preenchido apenas para ORGANIZATION
        type:
          type: string
          enum:
            - INTERNAL
            - ENVIRONMENT
            - ORGANIZATION
          description: Tipo da role (INTERNAL, ENVIRONMENT ou ORGANIZATION)
        name:
          type: string
          description: 'Nome do papel (ex.: "Admin", "Agente")'
        description:
          type: string
          nullable: true
          description: Descrição do papel
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que criou o registro, quando aplicável
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que fez a última atualização, quando aplicável
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
        deletedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que removeu o registro, quando aplicável
        deletedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de remoção
      required:
        - roleId
        - organizationId
        - type
        - name
        - description
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
        - deletedBy
        - deletedAt
      description: Papéis de acesso internos, de ambiente ou customizados por organização
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````