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

# Listar sessões STS

> Lista as sessões STS (assunção de função) ativas e recentes para a conta selecionada. Requer `iam:ListSTSSessions` permissão.


<Info>
  Requer a ação do IAM **`iam:ListSTSSessions`**. 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 get /v1/sts-sessions
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/sts-sessions:
    get:
      tags:
        - IAM
      summary: Listar sessões STS
      description: >
        Lista as sessões STS (assunção de função) ativas e recentes para a conta
        selecionada. Requer `iam:ListSTSSessions` permissão.
      operationId: listSTSSessions
      parameters:
        - $ref: '#/components/parameters/IAMNameFilter'
        - $ref: '#/components/parameters/IAMCRNFilter'
        - name: role
          in: query
          description: >-
            UUID da função, nome imutável ou CRN da função qualificada pela
            conta.
          schema:
            type: string
            example: b2c3d4e5-f6a7-8901-2345-67890abcdef1
        - name: principal
          in: query
          description: >-
            Referência principal; principal_type é obrigatório. Usuários e
            sessões de função assumida aceitam UUID ou CRN; funções e contas de
            serviço também aceitam nomes na conta proprietária.
          schema:
            type: string
            example: 550e8400-e29b-41d4-a716-446655440000
        - name: principal_type
          in: query
          description: >
            Filtrar por tipo principal. `assumed_role` seleciona as sessões que
            a encadeamento de funções produz, onde uma sessão de função assumida
            existente assumiu outra função.
          schema:
            type: string
            enum:
              - user
              - service_account
              - role
              - assumed_role
            example: service_account
        - name: active_only
          in: query
          description: Mostrar apenas sessões ativas (não expiradas, não revogadas)
          schema:
            type: boolean
            default: true
            example: true
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Marker'
      responses:
        '200':
          description: Lista de sessões do STS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/STSSessionListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    IAMNameFilter:
      name: name
      in: query
      allowEmptyValue: true
      description: >-
        Nome exato do recurso, combinado com crn usando AND antes da paginação.
        Valores vazios são filtros. Recursos sem um nome nunca correspondem.
      schema:
        type: string
    IAMCRNFilter:
      name: crn
      in: query
      allowEmptyValue: true
      description: >-
        Exato CRN retornado, combinado com o nome usando AND antes da paginação.
        CRNs mal formados ou vazios retornam 400; CRNs válidos incompatíveis ou
        estrangeiros retornam uma página vazia. Recursos sem um CRN nunca
        correspondem. CRNs com escopo de organização usam a organização
        autenticada.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: >-
        Número máximo de itens a devolver. Um valor acima do máximo é fixado ao
        invés de rejeitado, então uma página mais curta do que a que você pediu
        é normal — page until `meta.has_more` é false, não até que uma página
        pareça curta.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
    Marker:
      name: marker
      in: query
      description: >-
        Cursor de paginação opaco. Echo back o valor `meta.marker` da página
        anterior para buscar a próxima; não construa ou analise-o. A forma
        interna do token varia de acordo com o endpoint (um ID de recurso, um
        carimbo de data/hora, etc.) e não é garantida a estabilidade entre
        versões.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    STSSessionListResponse:
      type: object
      properties:
        sts_sessions:
          type: array
          items:
            $ref: '#/components/schemas/STSSession'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    STSSession:
      type: object
      description: >-
        Credenciais temporárias com escopo de conta, incluindo sessões OAuth de
        função assumida e conta de serviço. As sessões de login pessoais do
        navegador não estão listadas aqui. Uma sessão está ativa quando não é
        revogada e sua expiração é no futuro.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: f6a7b8c9-d0e1-2345-6789-0abcdef12345
        role_id:
          type: string
          description: >-
            O UUID da função assumida; ausente em sessões OAuth de conta de
            serviço que não assumem uma função.
          example: b2c3d4e5-f6a7-8901-2345-67890abcdef1
        principal_id:
          type: string
          format: uuid
          description: ID do principal assumindo a função (a identidade de origem)
          example: 550e8400-e29b-41d4-a716-446655440000
        principal_type:
          type: string
          enum:
            - user
            - service_account
            - assumed_role
          example: service_account
        session_name:
          type: string
          nullable: true
          description: Identificador de sessão opcional
          example: deploy-session
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        expires_at:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        last_used_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-15T09:45:00Z'
        revoked:
          type: boolean
          description: Se a sessão foi revogada
          example: false
        revoked_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-15T10:00:00Z'
        revoked_reason:
          type: string
          nullable: true
          example: Security incident response
        source_ip:
          type: string
          nullable: true
          description: Endereço IP onde a sessão foi criada
          example: 203.0.113.42
        user_agent:
          type: string
          nullable: true
          description: User-Agent do chamador que criou a sessão
          example: basaltic-cli/1.4.0
        account_id:
          type: string
          format: uuid
        account_handle:
          type: string
        source_account_id:
          type: string
          format: uuid
          nullable: true
        source_principal_type:
          type: string
          nullable: true
        source_principal_crn:
          type: string
          nullable: true
        parent_session_id:
          type: string
          format: uuid
          nullable: true
        grant_type:
          type: string
        crn:
          type: string
          example: crn:iam::production:sts-session/550e8400-e29b-41d4-a716-446655440001
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de itens
          example: 150
        limit:
          type: integer
          description: Número de itens por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para a próxima página. Passe-o de volta como o
            parâmetro de consulta `marker`; trate-o como um token, não um valor
            para analisar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Se há mais itens
          example: true
    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
  responses:
    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
  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.