> ## 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 logs de auditoria

> Listar logs de auditoria para a organização atual com filtragem e paginação. Requer `audit:ListLogs` permissão.


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


## OpenAPI

````yaml /pt/api-reference/specs/audit.yaml get /v1/audit-logs
openapi: 3.0.3
info:
  title: API de auditoria Basaltic
  version: 1.0.0
  description: >
    Acesso somente de leitura à trilha de auditoria da organização em suas
    contas e regiões. Os eventos retêm identidades de atores e recursos do tempo
    do evento. O acesso requer uma política de organização que conceda ações de
    auditoria.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://audit.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/audit-logs:
    get:
      tags:
        - Audit Logs
      summary: Listar logs de auditoria
      description: >
        Listar logs de auditoria para a organização atual com filtragem e
        paginação. Requer `audit:ListLogs` permissão.
      operationId: listAuditLogs
      parameters:
        - name: crn
          in: query
          description: >-
            CRN exato do evento de auditoria (crn:audit:::log/UUID). Identidades
            estrangeiras ou incompatíveis resultam em uma página em branco. Isso
            seleciona o próprio evento, independentemente dos snapshots de
            recurso e ator.
          schema:
            type: string
        - name: actor
          in: query
          description: >
            Filtre por um UUID canônico ou um CRN exato de ator em tempo de
            evento, incluindo usuários do Workspace, identidades de contas do
            IAM e CRNs históricos retidos. Corresponde identidades armazenadas
            com eventos na organização atual, incluindo atores excluídos. Nomes
            nulos e CRNs de curinga não são suportados. Eventos sem um CRN
            armazenado permanecem pesquisáveis por UUID.
          schema:
            type: string
            example: 550e8400-e29b-41d4-a716-446655440000
        - name: actor_type
          in: query
          description: Filtrar por tipo de ator
          schema:
            type: string
            enum:
              - user
              - service_account
              - system
            example: user
        - name: action
          in: query
          description: >-
            Filtrar por ação (correspondência exata ou prefixo com curinga, por
            exemplo, "iam.*")
          schema:
            type: string
            example: iam.policy.create
        - name: resource_type
          in: query
          description: Filtrar por tipo de recurso
          schema:
            type: string
            example: instance
        - name: resource
          in: query
          description: >
            Filtre por um UUID canônico ou um CRN de recurso em tempo de evento,
            sem procurar um recurso ativo. Um CRN corresponde exatamente e
            também corresponde a descendentes em um limite literal `/`:
            `crn:network:region:account:vpc/prod` corresponde a
            `crn:network:region:account:vpc/prod/subnet/private` armazenado. A
            conta e a região são correspondidas exatamente dentro da organização
            atual. Caracteres de porcentagem e sublinhado são literais, não
            curingas. Nomes nulos e CRNs de curinga não são suportados. Eventos
            sem um CRN armazenado permanecem pesquisáveis por UUID. O filtro
            resource_type se aplica de forma independente, inclusive a eventos
            descendentes.
          schema:
            type: string
            example: crn:network:sa-saopaulo-1:acme:vpc/prod
        - name: status
          in: query
          description: Filtrar por status
          schema:
            type: string
            enum:
              - success
              - failure
              - denied
            example: success
        - name: ip_address
          in: query
          description: Filtrar por endereço IP
          schema:
            type: string
            example: 192.168.1.100
        - name: from
          in: query
          description: Filtrar logs a partir deste carimbo de data/hora (inclusive)
          schema:
            type: string
            format: date-time
            example: '2026-01-01T00:00:00Z'
        - name: to
          in: query
          description: Filtrar registros até este carimbo de data/hora (exclusivo)
          schema:
            type: string
            format: date-time
            example: '2026-02-01T00:00:00Z'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Marker'
      responses:
        '200':
          description: Lista de logs de auditoria
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    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:
    AuditLogListResponse:
      type: object
      properties:
        audit_logs:
          type: array
          items:
            $ref: '#/components/schemas/AuditLog'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    AuditLog:
      type: object
      properties:
        crn:
          type: string
          description: >-
            Identidade de evento canônica, com escopo para a organização
            autenticada.
          example: crn:audit:::log/550e8400-e29b-41d4-a716-446655440000
        id:
          type: string
          format: uuid
          readOnly: true
          example: e5f6a7b8-c9d0-1234-5678-90abcdef1234
        timestamp:
          type: string
          format: date-time
          description: Quando o evento ocorreu
          example: '2026-01-15T09:30:00Z'
        actor_crn:
          type: string
          nullable: true
          description: >
            Identidade imutável do ator em tempo de evento. Nulo para entradas
            históricas sem um instantâneo. Novos eventos de usuário usam
            crn:workspace:::organization/<organization-uuid>/usuário/<user-uuid>;
            contas de serviço usam
            crn:iam::<account-handle>:serviço-de-conta/<name>; funções assumidas
            usam crn:iam::<account-handle>:papel/<name>, com a identidade da
            sessão em details.actor\_session\_crn. As entradas históricas mantêm
            seus CRNs originais, incluindo identidades de organização do IAM
            legadas.<service>, com nomes de serviço certificado, registro,
            segredos, fila, notificações e e-mail.
          example: >-
            crn:workspace:::organization/7c9e6679-7425-40de-944b-e07fc1f90ae7/user/550e8400-e29b-41d4-a716-446655440000
        resource_crn:
          type: string
          nullable: true
          description: >
            Identidade de recurso imutável em tempo de evento. Nulo para
            entradas históricas sem um instantâneo e eventos enumerados cujo
            destino não pode ser identificado a partir de dados de tempo de
            evento, como uma redefinição de senha de email desconhecido ou uma
            pesquisa que nunca resolveu uma linha. Um UUID de destino conhecido
            é mantido em details.resource_id; ele nunca é substituído pelo nome
            imutável em um CRN.
          example: crn:workspace:::organization/550e8400-e29b-41d4-a716-446655440000
        actor_name:
          type: string
          nullable: true
          description: Nome do ator no momento do evento
          example: John Doe
        actor_email:
          type: string
          nullable: true
          description: E-mail do ator (apenas para usuários)
          example: john.doe@acme.com
        action:
          type: string
          description: >-
            A ação realizada (por exemplo, "iam.policy.create",
            "instance.start")
          example: iam.policy.create
        status:
          type: string
          enum:
            - success
            - failure
            - denied
          description: Resultado da acção
          example: success
        resource_name:
          type: string
          nullable: true
          description: Nome do recurso no momento do evento
          example: web-server-1
        ip_address:
          type: string
          nullable: true
          description: Endereço IP da origem da solicitação
          example: 192.168.1.100
        user_agent:
          type: string
          nullable: true
          description: String do agente do usuário da solicitação
          example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
        request_id:
          type: string
          nullable: true
          description: Solicitar ID para correlação
          example: req-7c9e6679742540de
        details:
          type: object
          additionalProperties: true
          description: >
            Para atores com função assumida, actor\_session\_crn registra
            crn:iam:::sts-session/<id> para correlacionar o evento com sua
            chamada AssumeRole.
        error_code:
          type: string
          nullable: true
          description: Código de erro para ações com falha
          example: access_denied
        error_message:
          type: string
          nullable: true
          description: Mensagem de erro para ações com falha
          example: Principal is not authorized to perform this action
    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:
    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
  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.