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

# Lister les portées

> Lister toutes les portées de permission disponibles, y compris les intégrations de plateforme et les portées personnalisées du locataire

# Lister les portées

`GET /v1/scopes`

Retourne toutes les portées de permission disponibles pour le locataire authentifié. Cela inclut les portées intégrées définies par la plateforme et toutes les portées personnalisées créées par le locataire. Les portées suivent le format `resource:action` défini par le protocole MAIP.

### Authentification

Nécessite l'en-tête `X-API-Key` ou un jeton JWT Bearer. L'espace de travail est dérivé de l'identifiant authentifié ; n'envoyez pas `X-Tenant-ID`.

### Réponse

Retourne un tableau d'objets de définition de portée.

**id** `string`

UUID de la définition d'étendue.

**tenant\_id** `string`

UUID du locataire propriétaire de cette étendue. `null` pour les étendues intégrées au niveau de la plateforme
portées.

**scope** `string`

La chaîne de portée complète au format `resource:action` (par exemple, `"data:read"`,
`"model:train"`).

**resource** `string`

Le composant ressource de la portée (par exemple, `"data"`, `"model"`, `"tool"`).

**action** `string`

Le composant d'action de la portée (par exemple, `"read"`, `"write"`, `"*"`).

**display\_name** `string`

Nom lisible par l'homme pour la portée.

**description** `string`

Description détaillée de ce à quoi la portée donne accès.

**category** `string`

Catégorie de portée à des fins organisationnelles.

**is\_builtin** `boolean`

`true` pour les portées définies par la plateforme, `false` pour les portées personnalisées créées par le locataire.

**created\_at** `string`

Horodatage de création ISO 8601.

### Exemple

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

***

### Catégories de portée intégrées

La plateforme offre plus de 25 portées intégrées réparties en 6 catégories :

| Catégorie | Portées | Description |
| - | - | - |
| `data` | `read`, `write`, `delete`, `*` | Accès aux ressources de données |
| `model` | `train`, `evaluate`, `deploy`, `attest`, `*` | Cycle de vie du modèle ML |
| `tool` | `search.web`, `search.db`, `execute`, `*` | Invocation d'outil |
| `agent` | `delegate`, `manage`, `inspect`, `*` | Gestion du cycle de vie de l'agent |
| `admin` | `config`, `audit`, `billing`, `*` | Opérations administratives |
| `receipt` | `create`, `verify`, `revoke`, `*` | Gestion des reçus |

### Référence du format de portée

```
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 fr/mint-openapi.yaml GET /v1/scopes
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks est une infrastructure de vérification universelle pour les
    documents, les identifiants et les actifs numériques.

    Cette spécification définit l'API canonique pour interagir avec les services
    Truthlocks.


    ## URL de base

    - **Production** : `https://api.truthlocks.com`

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


    ## Authentification

    - **Clés API** : Utilisez l'en-tête `X-API-Key` pour les opérations de
    machine à machine

    - **Jetons Bearer** : Utilisez `Authorization: Bearer <jwt>` pour les
    opérations initiées par l'utilisateur


    ## Identité du locataire

    En production, l'identité du locataire est dérivée du contexte authentifié
    (clé API ou JWT).

    L'en-tête `X-Tenant-ID` est ignoré en production pour éviter l'usurpation
    d'identité.
  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 production
  - url: https://sandbox-api.truthlocks.com
    description: Environnement de bac à sable
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestion des clés API et des jetons
  - name: Issuers
    description: Enregistrement de l'émetteur et gestion de la confiance
  - name: Keys
    description: Gestion des clés cryptographiques pour les émetteurs
  - name: Attestations
    description: Cycle de vie de l'attestation (créer, révoquer, remplacer)
  - name: Verification
    description: Vérification des attestations et lots de preuves
  - name: Governance
    description: Flux de travail de gouvernance de l'émetteur (administrateur uniquement)
  - name: Identity
    description: Gestion de l'organisation, des utilisateurs et des rôles
  - name: Audit
    description: Requêtes d'événements d'audit
  - name: Tenant Console
    description: Points de terminaison du profil et du cycle de vie du locataire
  - name: Health
    description: Points de terminaison de l'état et de la disponibilité du service
  - name: Risk
    description: Ingestion de signaux de risque et détection de fraude
  - name: Risk Enforcement
    description: >-
      Actions d'application des risques — blocage, défi, quarantaine et
      configuration
  - name: Billing
    description: Gestion de la facturation, des abonnements et des modules complémentaires
  - name: Machine Identity
    description: >-
      Protocole d'identité d'agent machine (MAIP) — enregistrement d'agent,
      sessions, confiance, témoin, conformité, orchestration et observabilité
externalDocs:
  description: API de transparence en lecture seule (spécification de service séparée)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/scopes:
    get:
      tags:
        - Machine Identity
      summary: Lister les portées
      description: >-
        Retourne toutes les portées de permission disponibles pour le locataire
        authentifié, y compris les intégrations de plateforme et les portées
        personnalisées du locataire.
      operationId: maip.scopes.list
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - data
              - model
              - tool
              - agent
              - admin
              - receipt
              - custom
          description: Filtrer les portées par catégorie
      responses:
        '200':
          description: Portées 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: Authentification requise
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Limite de débit dépassée
          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: Code d'erreur lisible par machine
          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: Message d'erreur lisible par l'homme
        http_status:
          type: integer
          description: Code de statut HTTP
        retry_after_ms:
          type: integer
          description: >-
            Millisecondes à attendre avant de réessayer (pour les limites de
            débit)
        details:
          type: object
          description: Contexte d'erreur supplémentaire
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clé API pour l'authentification machine-à-machine
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT pour les opérations initiées par l'utilisateur

````

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