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

# Assumir função

> Assuma uma função nesta conta ou em outra conta na mesma organização. O chamador precisa da permissão iam:AssumeRole (ou de uma atribuição de função de conta de Workspace efetiva) e a função de destino deve confiar no chamador de forma independente.

A conta de sessão vem da função de destino, não do cabeçalho selected-account. A sessão usa as permissões da função de destino e as políticas de organização delegadas, sujeitas aos limites aplicáveis, negações explícitas e uma política de restrição de sessão opcional. As permissões de principal de origem não são unidas na sessão.


<Info>
  Requer a ação do IAM **`iam:AssumeRole`**. 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 post /v1/assume-role
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/assume-role:
    post:
      tags:
        - IAM
      summary: Assumir função
      description: >
        Assuma uma função nesta conta ou em outra conta na mesma organização. O
        chamador precisa da permissão iam:AssumeRole (ou de uma atribuição de
        função de conta de Workspace efetiva) e a função de destino deve confiar
        no chamador de forma independente.


        A conta de sessão vem da função de destino, não do cabeçalho
        selected-account. A sessão usa as permissões da função de destino e as
        políticas de organização delegadas, sujeitas aos limites aplicáveis,
        negações explícitas e uma política de restrição de sessão opcional. As
        permissões de principal de origem não são unidas na sessão.
      operationId: assumeRole
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssumeRoleRequest'
      responses:
        '200':
          description: Função assumida com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssumeRoleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Não tem permissão para assumir este papel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          description: >
            A credencial não foi recusada — uma dependência de plataforma não
            pôde concluir a troca. Tente novamente em vez de rodar a função ou a
            chave.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: SERVICE_UNAVAILABLE
                  message: >-
                    The service is temporarily unavailable. Please try again
                    later.
                  request_id: 550e8400-e29b-41d4-a716-446655440000
      security:
        - BearerAuth: []
components:
  schemas:
    AssumeRoleRequest:
      type: object
      additionalProperties: false
      required:
        - role
      properties:
        role:
          $ref: '#/components/schemas/RoleReference'
        duration_seconds:
          type: integer
          minimum: 900
          maximum: 43200
          default: 3600
          description: Duração da validade da credencial (15 min a 12 horas)
          example: 3600
        policy:
          $ref: '#/components/schemas/SessionPolicyDocument'
    AssumeRoleResponse:
      type: object
      description: >
        As credenciais de uma sessão de função, em ambas as formas que podem ser
        apresentadas.


        `access_token` é um token de portador para esta API — envie-o como
        `Authorization: Bearer <token>`. Os outros quatro campos são credenciais
        do AWS SigV4 para o endpoint de armazenamento de objetos compatível com
        o S3, que não diz mais nada.


        Ambos vêm da mesma sessão e compartilham sua expiração, portanto,
        revogar a sessão interrompe ambos de uma só vez. Use o que o endpoint
        que você está chamando precisa; não há necessidade de escolher um no
        momento da solicitação.
      properties:
        access_token:
          type: string
          description: >
            Token de portador para a API Basaltic. Esteja presente em cada
            sessão de função.
          example: eyJhbGciOiJFUzI1NiIsInR5cCI6ImF0K2p3dCIsImtpZCI6Ii4uLiJ9...
        token_type:
          type: string
          description: Sempre `Bearer` quando `access_token` está presente.
          example: Bearer
        expires_in:
          type: integer
          description: Segundos até que o `access_token` expire.
          example: 3600
        access_key_id:
          type: string
          description: ID da chave de acesso SigV4, para o endpoint S3.
          example: AKIA...
        secret_access_key:
          type: string
          description: SigV4 secreto, para o endpoint S3.
          example: wJalrXUtnFEMI...
        session_token:
          type: string
          description: >
            Token de sessão SigV4, para o endpoint S3. Envie como
            `X-Amz-Security-Token` e inclua-o em `SignedHeaders`.
          example: FwoGZXIvYXdzE...
        expiration:
          type: string
          format: date-time
          description: >
            Quando a sessão — e, portanto, ambos os formulários de credenciais —
            expira.
          example: '2026-01-15T09:30:00Z'
        account_id:
          type: string
          description: UUID da conta proprietária da função de destino.
          format: uuid
        account_handle:
          type: string
          description: O identificador da conta proprietária da função de destino.
        role_id:
          type: string
          description: UUID imutável da função assumida.
          format: uuid
    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
    RoleReference:
      type: string
      description: >-
        UUID da função da conta, nome imutável na conta selecionada, ou
        crn:iam::<account-handle>:papel/<name>. AssumeRole pode usar um CRN
        qualificado para direcionar outra conta na mesma organização.A sessão
        resultante é vinculada à conta de função de destino.
      example: crn:iam::production:role/reports
    SessionPolicyDocument:
      type: object
      description: >
        Uma política em linha que abrange as credenciais que estão sendo
        criadas. Ele não concede nada por si só: cada solicitação feita com as
        credenciais resultantes deve ser permitida pelas políticas efetivas da
        função assumida *e* por este documento, então ele só pode restringir as
        permissões da função assumida.


        O documento é validado no caminho e armazenado com a sessão — um
        documento inválido falha a chamada com `INVALID_INPUT` As declarações
        tomam a mesma forma que em uma política gerenciada, mas não carregam
        nenhuma informação sobre o que está sendo feito.

        `conditions`; uma política de sessão restringe apenas ações e recursos.
      required:
        - version
        - statements
      properties:
        version:
          type: string
          enum:
            - '2024-01-01'
          example: '2024-01-01'
        statements:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/SessionPolicyStatement'
      example:
        version: '2024-01-01'
        statements:
          - effect: allow
            actions:
              - storage:GetObject
            resources:
              - crn:storage:sa-saopaulo-1::bucket/reports/*
    SessionPolicyStatement:
      type: object
      description: >
        Uma declaração de política de sessão. Mesma exclusividade de
        ação/recurso como `PolicyStatement` — exatamente uma de
        `actions`/`not_actions` e uma de `resources`/`not_resources`.
      required:
        - effect
      allOf:
        - oneOf:
            - required:
                - actions
            - required:
                - not_actions
        - oneOf:
            - required:
                - resources
            - required:
                - not_resources
      properties:
        sid:
          type: string
          description: Identificador da declaração
          example: OnlyReports
        effect:
          type: string
          enum:
            - allow
            - deny
          example: allow
        actions:
          type: array
          minItems: 1
          items:
            type: string
          description: Ações no formato service:action
          example:
            - storage:GetObject
        not_actions:
          type: array
          minItems: 1
          items:
            type: string
          description: A declaração abrange todas as ações, exceto estas
          example:
            - iam:*
        resources:
          type: array
          minItems: 1
          items:
            type: string
          description: Identificadores ou padrões de recursos
          example:
            - crn:storage:sa-saopaulo-1::bucket/reports/*
        not_resources:
          type: array
          minItems: 1
          items:
            type: string
          description: A declaração abrange todos os recursos, exceto estes
          example:
            - crn:iam::production:role/*
  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
    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
    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.