> ## 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 ámbitos

> Listar todos los ámbitos de permisos disponibles, incluidos los integrados en la plataforma y los ámbitos personalizados del inquilino

# Listar Ámbitos

`GET /v1/scopes`

Devuelve todos los ámbitos de permiso disponibles para el inquilino autenticado. Esto incluye los ámbitos incorporados definidos por la plataforma y cualquier ámbito personalizado creado por el inquilino. Los ámbitos siguen el formato `resource:action` definido por el protocolo MAIP.

### Autenticación

Requiere el encabezado `X-API-Key` o el token Bearer JWT. El espacio de trabajo se deriva de la credencial autenticada; no envíe `X-Tenant-ID`.

### Respuesta

Devuelve una matriz de objetos de definición de ámbito.

**id** `string`

UUID de la definición de ámbito.

**tenant\_id** `string`

UUID del inquilino propietario de este ámbito. `null` para los integrados a nivel de plataforma
ámbitos.

**scope** `string`

La cadena de alcance completa en formato `resource:action` (por ejemplo, `"data:read"`,
`"model:train"`).

**resource** `string`

El componente de recurso del alcance (por ejemplo, `"data"`, `"model"`, `"tool"`).

**action** `string`

El componente de acción del alcance (por ejemplo, `"read"`, `"write"`, `"*"`).

**display\_name** `string`

Nombre legible por humanos para el alcance.

**description** `string`

Descripción detallada de a qué otorga acceso el ámbito.

**category** `string`

Categoría de alcance para fines organizativos.

**is\_builtin** `boolean`

`true` para ámbitos definidos por la plataforma, `false` para ámbitos personalizados creados por el inquilino.

**created\_at** `string`

Marca de tiempo de creación ISO 8601.

### Ejemplo

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

***

### Categorías de ámbito incorporadas

La plataforma ofrece más de 25 alcances incorporados en 6 categorías:

| Categoría | Alcances | Descripción |
| - | - | - |
| `data` | `read`, `write`, `delete`, `*` | Acceso a recursos de datos |
| `model` | `train`, `evaluate`, `deploy`, `attest`, `*` | Ciclo de vida del modelo ML |
| `tool` | `search.web`, `search.db`, `execute`, `*` | Invocación de herramientas |
| `agent` | `delegate`, `manage`, `inspect`, `*` | Gestión del ciclo de vida del agente |
| `admin` | `config`, `audit`, `billing`, `*` | Operaciones administrativas |
| `receipt` | `create`, `verify`, `revoke`, `*` | Gestión de recibos |

### Referencia de formato de alcance

```
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 es/mint-openapi.yaml GET /v1/scopes
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks es una infraestructura de verificación universal para documentos,
    credenciales y activos digitales.

    Esta especificación define la API canónica para interactuar con los
    servicios de Truthlocks.


    ## URLs Base

    - **Producción**: `https://api.truthlocks.com`

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


    ## Autenticación

    - **Claves API**: Use el encabezado `X-API-Key` para operaciones máquina a
    máquina

    - **Tokens Bearer**: Use `Authorization: Bearer <jwt>` para operaciones
    iniciadas por el usuario


    ## Identidad del Inquilino

    En producción, la identidad del inquilino se deriva del contexto autenticado
    (clave API o JWT).

    El encabezado `X-Tenant-ID` se ignora en producción para evitar la
    suplantación de identidad.
  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 producción
  - url: https://sandbox-api.truthlocks.com
    description: Entorno Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestión de claves y tokens de API
  - name: Issuers
    description: Registro del emisor y gestión de la confianza
  - name: Keys
    description: Gestión de claves criptográficas para emisores
  - name: Attestations
    description: Ciclo de vida de la atestación (acuñar, revocar, reemplazar)
  - name: Verification
    description: Verificación de atestación y paquetes de prueba
  - name: Governance
    description: Flujos de trabajo de gobernanza del emisor (solo administrador)
  - name: Identity
    description: Gestión de organización, usuarios y roles
  - name: Audit
    description: Consultas de eventos de auditoría
  - name: Tenant Console
    description: Puntos finales de perfil y ciclo de vida del inquilino
  - name: Health
    description: Endpoints de estado y preparación del servicio
  - name: Risk
    description: Ingesta de señales de riesgo y detección de fraude
  - name: Risk Enforcement
    description: >-
      Acciones de aplicación de riesgos: bloqueo, desafío, cuarentena y
      configuración
  - name: Billing
    description: Gestión de facturación, suscripciones y complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidad de Agente de Máquina (MAIP) — registro de agentes,
      sesiones, confianza, testigo, cumplimiento, orquestación y observabilidad
externalDocs:
  description: API de transparencia de solo lectura (especificación de servicio separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/scopes:
    get:
      tags:
        - Machine Identity
      summary: Listar ámbitos
      description: >-
        Devuelve todos los ámbitos de permiso disponibles para el inquilino
        autenticado, incluidos los incorporados en la plataforma y los ámbitos
        personalizados del inquilino.
      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 categoría
      responses:
        '200':
          description: Ámbitos disponibles
          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: Autenticación requerida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Límite de velocidad 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 error legible 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: Mensaje de error legible por humanos
        http_status:
          type: integer
          description: Código de estado HTTP
        retry_after_ms:
          type: integer
          description: Milisegundos a esperar antes de reintentar (para límites de tasa)
        details:
          type: object
          description: Contexto de error adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clave API para autenticación máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operaciones iniciadas por el usuario

````

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