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

# Listar Escopos

> Listar todos os escopos de permissão disponíveis, incluindo os internos da plataforma e os escopos personalizados do locatário

# Listar Escopos

`GET /v1/scopes`

Retorna todos os escopos de permissão disponíveis para o locatário autenticado. Isso inclui escopos internos definidos pela plataforma e quaisquer escopos personalizados criados pelo locatário. Os escopos seguem o formato `resource:action` definido pelo protocolo MAIP.

### Autenticação

Requer cabeçalho `X-API-Key` ou token JWT de portador. O espaço de trabalho é derivado da credencial autenticada; não envie `X-Tenant-ID`.

### Resposta

Retorna um array de objetos de definição de escopo.

**id** `string`

UUID da definição de escopo.

**tenant\_id** `string`

UUID do locatário que possui este escopo. `null` para incorporado no nível da plataforma
escopos.

**scope** `string`

A string de escopo completa no formato `resource:action` (por exemplo, `"data:read"`,
`"model:train"`).

**resource** `string`

O componente de recurso do escopo (por exemplo, `"data"`, `"model"`, `"tool"`).

**action** `string`

O componente de ação do escopo (por exemplo, `"read"`, `"write"`, `"*"`).

**display\_name** `string`

Nome legível por humanos para o escopo.

**description** `string`

Descrição detalhada do que o escopo concede acesso.

**category** `string`

Categoria de escopo para fins organizacionais.

**is\_builtin** `boolean`

`true` para escopos definidos pela plataforma, `false` para escopos personalizados criados pelo locatário.

**created\_at** `string`

Carimbo de data/hora de criação ISO 8601.

### Exemplo

```bash theme={null}
curl -G https://api.truthlocks.com/v1/scopes \
  -H "X-API-Key: tl_live_..." \
  -d "category=data"
```

***

### Categorias de Escopo Integradas

A plataforma oferece mais de 25 escopos integrados em 6 categorias:

| Categoria | Escopos | Descrição |
| - | - | - |
| `data` | `read`, `write`, `delete`, `*` | Acesso a recursos de dados |
| `model` | `train`, `evaluate`, `deploy`, `attest`, `*` | Ciclo de vida do modelo ML |
| `tool` | `search.web`, `search.db`, `execute`, `*` | Invocação de ferramenta |
| `agent` | `delegate`, `manage`, `inspect`, `*` | Gerenciamento do ciclo de vida do agente |
| `admin` | `config`, `audit`, `billing`, `*` | Operações administrativas |
| `receipt` | `create`, `verify`, `revoke`, `*` | Gerenciamento de recibos |

### Referência de Formato de Escopo

```
resource:action         Standard scope (e.g., "data:read")
resource:*              Wildcard scope (e.g., "data:*" grants all data actions)
!resource:action        Negation scope (e.g., "!data:delete" explicitly denies)
resource:sub.action     Dotted sub-actions (e.g., "tool:search.web")
```


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/scopes
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/scopes:
    get:
      tags:
        - Machine Identity
      summary: Listar Escopos
      description: >-
        Retorna todos os escopos de permissão disponíveis para o locatário
        autenticado, incluindo os internos da plataforma e os escopos
        personalizados do locatário.
      operationId: maip.scopes.list
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - data
              - model
              - tool
              - agent
              - admin
              - receipt
              - custom
          description: Filtrar âmbitos por categoria
      responses:
        '200':
          description: Escopos disponíveis
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    tenant_id:
                      format: uuid
                      nullable: true
                      type: string
                    scope:
                      type: string
                    resource:
                      type: string
                    action:
                      type: string
                    display_name:
                      type: string
                    description:
                      type: string
                    category:
                      type: string
                    is_builtin:
                      type: boolean
                    created_at:
                      type: string
                      format: date-time
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Código de erro legível por máquina
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Mensagem de erro legível por humanos
        http_status:
          type: integer
          description: Código de status HTTP
        retry_after_ms:
          type: integer
          description: >-
            Milissegundos para aguardar antes de tentar novamente (para limites
            de taxa)
        details:
          type: object
          description: Contexto de erro adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

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