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

# Atualizar um papel

> Realiza uma atualização de substituição completa dos campos mutáveis do papel em uma única solicitação, incluindo o conjunto completo de permissões.



## OpenAPI

````yaml /pt-BR/api-reference/openapi.pt-v2.json put /v2/organizations/{organization_id}/roles/{role_id}
openapi: 3.0.3
info:
  title: API Publica Portal
  version: 2.0.0
  description: API pública REST para portal
servers:
  - url: https://api.flexxible.net
    description: Portal API (production)
security:
  - bearerAuth: []
tags:
  - name: Atividade digital
    description: Criação de grupos de processos principais por organização
  - name: Roles
    description: Endpoint de creacion de roles de organizacion
  - name: Usuarios
    description: Endpoint de creacion de usuarios de organizacion
  - name: Grupos de workspaces
    description: Endpoints de gestión de grupos de workspaces
  - name: Workspaces
    description: Endpoint de eliminacion de workspaces de la organizacion
  - name: Aplicaciones instaladas
    description: Endpoint de detalle de aplicación instalada de la organización
  - name: Autenticación
    description: Endpoints de autenticación y contexto de sesión
  - name: Microservicios
    description: Detalle de microservicios por organizacion
  - name: Operaciones
    description: Consulta de detalle de operaciones por organización
  - name: Organización
    description: Operaciones de organización
  - name: Objetivos de política de parches
    description: Endpoints de gestión de objetivos de política de parches
  - name: Configuraciones de producto
    description: Endpoints de gestión de configuraciones de producto
  - name: Grupos de reporte
    description: Operaciones sobre grupos de reporte
  - name: Sesiones
    description: Endpoint de detalle de sesion de la organizacion
  - name: Tenants
    description: Endpoints de gestión de tenants
paths:
  /v2/organizations/{organization_id}/roles/{role_id}:
    put:
      tags:
        - Funções
      summary: Atualizar um papel
      description: >-
        Realiza uma atualização de substituição completa dos campos mutáveis do
        papel em uma única solicitação, incluindo o conjunto completo de
        permissões.
      operationId: update_role_by_id
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9a-f]{24}$
            minLength: 24
            maxLength: 24
          description: Identificador de organização.
          example: 507f1f77bcf86cd799439011
        - name: role_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9a-f]{24}$
            minLength: 24
            maxLength: 24
          description: Identificador de papel.
          example: 64f0c2a1b2d3e4f5060708aa
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequestV2'
            examples:
              full_update_organization_scoped:
                summary: Atualizar papel com permissões de alcance organizacional
                value:
                  name: Operador de organizacion
                  permissions:
                    - target_organization: 507f1f77bcf86cd799439011
                      portal_permission: organization_admin
                      workspaces_permission: admin_read_only
                      analyzer_permission: access
                      target_reporting_groups:
                        - 64f0c2a1b2d3e4f5060708c1
                        - 64f0c2a1b2d3e4f5060708c2
              full_update_mixed_scopes:
                summary: Atualizar papel com permissões de alcance misto
                value:
                  name: Soporte de plataforma
                  permissions:
                    - target_organization: all
                      portal_permission: platform
                      workspaces_permission: admin
                      analyzer_permission: admin
                      target_reporting_groups: all
                    - target_organization: 507f1f77bcf86cd799439011
                      portal_permission: l2_support_team
                      workspaces_permission: l2_support_team
                      analyzer_permission: access
                      target_reporting_groups:
                        - 64f0c2a1b2d3e4f5060708d1
      responses:
        '200':
          description: Papel atualizado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleV2'
        '400':
          description: >-
            Parâmetro de rota inválido ou contrato do corpo de solicitação
            inválido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_request_body:
                  summary: Carga útil de atualização malformada
                  value:
                    error:
                      message: Cuerpo de solicitud invalido
                      code: bad_request
                      details: >-
                        permissions[0].target_organization debe ser una cadena
                        hexadecimal en minusculas de 24 caracteres o el valor
                        all
        '401':
          description: Não autorizado ou a organização não é acessível.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                organization_not_authorized:
                  summary: Falha de acesso à organização
                  value:
                    error:
                      message: No autorizado
                      code: unauthorized
        '404':
          description: >-
            O papel não foi encontrado dentro do alcance autorizado da
            organização.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                role_not_found:
                  summary: Papel solicitado não encontrado
                  value:
                    error:
                      message: Rol no encontrado
                      code: not_found
        '409':
          description: A solicitação conflita com o estado existente do papel.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                role_name_conflict:
                  summary: O nome do papel já existe
                  value:
                    error:
                      message: El nombre del rol ya existe
                      code: conflict
                      details: name ya esta en uso dentro de esta organizacion
        '500':
          description: Erro interno do servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unexpected_error:
                  summary: Falha não controlada
                  value:
                    error:
                      message: Error interno del servidor
                      code: internal_error
components:
  schemas:
    UpdateRoleRequestV2:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
          description: Nome do papel do usuário.
        permissions:
          type: array
          minItems: 1
          description: >-
            Entradas completas de permissões que definem o estado final do
            papel.
          items:
            $ref: '#/components/schemas/UpdateRolePermissionItemV2'
      required:
        - name
        - permissions
    RoleV2:
      type: object
      properties:
        id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do papel.
        name:
          type: string
          description: Nome do papel.
        organization_id:
          type: string
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador da organização associada a este papel.
        created_at:
          type: string
          format: date-time
          description: Carimbo de tempo de criação do papel em formato ISO 8601.
        created_by:
          type: string
          nullable: true
          pattern: ^[0-9a-f]{24}$
          minLength: 24
          maxLength: 24
          description: Identificador do usuário que criou o papel.
        permissions:
          type: array
          nullable: true
          description: Entradas de permissões configuradas para este papel.
          items:
            $ref: '#/components/schemas/GetRolePermissionItemV2'
      required:
        - id
        - name
        - organization_id
        - created_at
        - created_by
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details:
              type: string
          required:
            - message
            - code
      required:
        - error
    UpdateRolePermissionItemV2:
      type: object
      properties:
        target_organization:
          oneOf:
            - type: string
              enum:
                - all
            - type: string
              pattern: ^[0-9a-f]{24}$
              minLength: 24
              maxLength: 24
          description: >-
            Âmbito de organização da permissão. Use all para todas as
            organizações ou um organization_id específico.
        portal_permission:
          type: string
          enum:
            - admin
            - organization_admin
            - organization_admin_read_only
            - user
            - platform
            - l1_support_team
            - l1_support_team_read_only
            - l2_support_team
            - l2_support_team_read_only
            - l3_engineering_team
            - l3_engineering_team_read_only
            - billing
          description: Nível de permissão do Portal.
        workspaces_permission:
          type: string
          enum:
            - no_access
            - l1_support_team_read_only
            - l1_support_team
            - l2_support_team_read_only
            - l2_support_team
            - l3_engineering_team_read_only
            - l3_engineering_team
            - admin_read_only
            - admin
          description: Nível de permissão do Workspaces.
        analyzer_permission:
          type: string
          enum:
            - no_access
            - access
            - admin
          description: Nível de permissão do Analyzer.
        target_reporting_groups:
          oneOf:
            - type: string
              enum:
                - all
            - type: array
              minItems: 1
              items:
                type: string
                pattern: ^[0-9a-f]{24}$
                minLength: 24
                maxLength: 24
          description: >-
            Âmbito dos grupos de relatório da permissão. Use all para todos os
            grupos ou uma lista de reporting_group_id.
      required:
        - target_organization
        - portal_permission
        - workspaces_permission
        - analyzer_permission
        - target_reporting_groups
    GetRolePermissionItemV2:
      type: object
      properties:
        portal_permission:
          type: string
          nullable: true
          enum:
            - admin
            - organization_admin
            - organization_admin_read_only
            - user
            - platform
            - l1_support_team
            - l1_support_team_read_only
            - l2_support_team
            - l2_support_team_read_only
            - l3_engineering_team
            - l3_engineering_team_read_only
            - billing
          description: Nível de permissão do Portal.
        workspaces_permission:
          type: string
          nullable: true
          enum:
            - no_access
            - l1_support_team_read_only
            - l1_support_team
            - l2_support_team_read_only
            - l2_support_team
            - l3_engineering_team_read_only
            - l3_engineering_team
            - admin_read_only
            - admin
          description: Nível de permissão do Workspaces.
        analyzer_permission:
          type: string
          nullable: true
          enum:
            - no_access
            - access
            - admin
          description: Nível de permissão do Analyzer.
        target_organization:
          oneOf:
            - type: string
              enum:
                - all
            - type: string
              pattern: ^[0-9a-f]{24}$
              minLength: 24
              maxLength: 24
          description: >-
            Âmbito de organização da permissão: `all` para todas as organizações
            ou um `organization_id` específico.
        target_reporting_groups:
          oneOf:
            - type: string
              enum:
                - all
            - type: array
              minItems: 1
              items:
                type: string
                pattern: ^[0-9a-f]{24}$
                minLength: 24
                maxLength: 24
          description: >-
            Âmbito dos grupos de relatório da permissão: `all` para todos os
            grupos ou lista de `reporting_group_id` específicos.
      required:
        - target_organization
        - target_reporting_groups
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````