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

# Atualizar a função

> Atualizar uma função existente

<Info>
  Requer a ação do IAM **`iam:UpdateRole`**. Consulte [permissões de IAM](/pt/iam/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/iam.yaml patch /v1/roles/{role_id}
openapi: 3.0.3
info:
  title: API do Basaltic IAM
  version: 1.0.0
  description: >
    Gerenciamento de identidade e acesso de conta: contas de serviço, funções,
    políticas de conta e sessões temporárias com escopo de conta. A autenticação
    e o login pessoal permanecem no IAM. Organizações, contas, usuários, grupos
    e políticas da organização são gerenciados pela API do Workspace.


    As funções e políticas personalizadas pertencem à conta selecionada.Seus
    CRNs globais usam uma região vazia e o identificador da conta proprietária.
    Políticas de sistema compartilhadas usam crn:iam:::policy/<name>As entradas
    de relacionamento são classificadas uma vez como CRN, UUID ou nome, sem
    fallback de sintaxe.


    AssumeRole resolve a conta de propriedade da função de destino. O chamador
    precisa de permissão de origem e a função de destino deve confiar no
    chamador; a sessão resultante usa somente as permissões da função de
    destino, sujeita a limites e restrições de sessão.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://iam.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/roles/{role_id}:
    patch:
      tags:
        - IAM
      summary: Atualizar a função
      description: Atualizar uma função existente
      operationId: updateRole
      parameters:
        - $ref: '#/components/parameters/RoleId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleUpdateRequest'
      responses:
        '200':
          description: Função atualizada
          content:
            application/json:
              schema:
                type: object
                properties:
                  role:
                    $ref: '#/components/schemas/Role'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    RoleId:
      name: role_id
      in: path
      description: ID da função
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    RoleUpdateRequest:
      type: object
      additionalProperties: false
      properties:
        description:
          type: string
          maxLength: 1000
          example: Read-only access to S3 buckets
        tags:
          $ref: '#/components/schemas/Tags'
        trust_policy:
          $ref: '#/components/schemas/TrustPolicy'
      description: O nome do recurso é imutável.
    Role:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: b2c3d4e5-f6a7-8901-2345-67890abcdef1
        crn:
          type: string
          readOnly: true
          description: Nome do recurso da nuvem
          example: crn:iam::production:role/reports
        name:
          description: >-
            Os nomes de recursos não devem começar com o prefixo literal crn: ou
            ser UUIDs (formas canônicas, compactas, entre colchetes ou
            urn:uuid:, em qualquer caso).
          type: string
          example: S3ReadOnly
        description:
          type: string
          example: Read-only access to S3 buckets
        tags:
          $ref: '#/components/schemas/Tags'
        trust_policy:
          $ref: '#/components/schemas/TrustPolicy'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-16T14:20:00Z'
        account_id:
          type: string
          format: uuid
          readOnly: true
          description: UUID da conta proprietária.
        account_handle:
          type: string
          readOnly: true
          description: Identificador imutável da conta proprietária.
          example: production
        is_system:
          type: boolean
          readOnly: true
          description: As funções do sistema não podem ser alteradas ou excluídas.
        builtin_kind:
          type: string
          readOnly: true
          enum:
            - administrator
            - readonly
          description: >-
            Presente nas funções de Administrador e Somente leitura integradas
            da conta. Essas funções atribuíveis são criadas com a conta, não
            consomem cota de função personalizada e não bloqueiam a exclusão da
            conta.
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    TrustPolicy:
      type: object
      description: Define quem/o que pode assumir esse papel usando padrões CRN
      properties:
        principals:
          type: array
          description: >
            Padrões CRN qualificados identificando quem pode assumir essa função
            de conta. Só a associação à mesma organização não estabelece
            confiança. O chamador também precisa da permissão iam:AssumeRole
            para a função de destino.


            Funções de conta e contas de serviço usam
            crn:iam::<account-handle>:papel/<name> e
            crn:iam::<account-handle>:serviço-de-conta/<name>. Usuários humanos
            usam crn:workspace:::user/<username> ou crn:workspace:::user/\* na
            organização selecionada.Uma instância apresenta seu CRN de
            computação por meio do IMDS. Um chamador federado nomeia o provedor
            confiável como crn:iam:::oidc-provider/<provider> e usa condições
            para restringir as declarações de token.
          items:
            type: string
          example:
            - crn:iam::automation:service-account/deploy-bot
            - crn:workspace:::user/ana
        conditions:
          type: array
          description: Condições opcionais para a assunção de função
          items:
            $ref: '#/components/schemas/PolicyCondition'
      example:
        principals:
          - crn:compute:*:*:instance/*
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    PolicyCondition:
      type: object
      description: Uma condição que deve ser satisfeita para que a instrução se aplique
      required:
        - operator
        - key
        - values
      properties:
        operator:
          type: string
          enum:
            - equals
            - not_equals
            - starts_with
            - ends_with
            - contains
            - in
            - not_in
            - greater_than
            - less_than
            - greater_than_or_equals
            - less_than_or_equals
            - exists
            - not_exists
            - ip_address
            - not_ip_address
          description: O operador de comparação
          example: equals
        key:
          type: string
          description: A chave de condição a avaliar
          example: s3:prefix
        values:
          type: array
          items:
            type: string
          description: Valores para comparar
          example:
            - home/
            - shared/
        set_operator:
          type: string
          enum:
            - for_all_values
            - for_any_value
          description: >
            Avalia `operator` contra uma chave de contexto multi-valor (um
            conjunto, como `basalt:TagKeys` — as chaves de tag que uma
            requisição carrega) em vez de um único valor. Omitir para uma
            condição de valor único comum.


            - `for_all_values` — mantém quando cada membro do conjunto de
            solicitação satisfaz `operator`. Um conjunto ausente ou vazio é
            mantido vacuamente, então uma requisição que não possui tags não é
            cercada por uma restrição de tag-chave.

            - `for_any_value` — mantém quando pelo menos um membro faz. Um
            conjunto ausente ou vazio não se mantém.
          example: for_all_values
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Conflict:
      description: Conflito de recursos (por exemplo, já existe, estado inválido)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONFLICT
              message: Resource with this name already exists
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.