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

# Créer une portée

> Créer une portée de permission personnalisée au niveau du locataire pour un contrôle d'accès granulaire des agents

# Créer une portée

`POST /v1/scopes`

Crée une portée de permission personnalisée pour le locataire authentifié. Les portées personnalisées étendent le registre de portées intégré avec des permissions spécifiques au locataire. La chaîne de portée est automatiquement composée à partir des champs `resource` et `action` au format `resource:action`.

Les étendues personnalisées sont validées par rapport aux règles de format d'étendue MAIP : caractères alphanumériques, points, underscores, tirets et astérisques uniquement.

> [!NOTE]
>
> Les étendues personnalisées sont isolées par locataire. Elles n'apparaissent pas dans l'étendue des autres locataires
> registres. Les portées de plateforme intégrées ne peuvent pas être outrepassées ou dupliquées.

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

**id** `string`

UUID de la définition d'étendue nouvellement créée.

**tenant\_id** `string`

UUID du locataire propriétaire.

**scope** `string`

La chaîne de portée composée au format `resource:action`.

**resource** `string`

Le composant ressource.

**action** `string`

Le composant d'action.

**display\_name** `string`

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

**description** `string`

Description de la portée.

**category** `string`

Catégorie de portée.

**is\_builtin** `boolean`

Toujours `false` pour les étendues créées par le locataire.

**created\_at** `string`

Horodatage de création ISO 8601.

### Exemple

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/scopes \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "crm",
    "action": "contact.enrich",
    "display_name": "CRM Contact Enrichment",
    "description": "Allows agents to enrich CRM contact records via third-party providers",
    "category": "integration"
  }'
```

***

### Attribution de portées personnalisées aux agents

Après avoir créé une portée personnalisée, attribuez-la aux agents lors de l'[enregistrement](https://docs.truthlocks.com/fr/api-reference/machine-identity/agents/register.md) ou via la [délégation](https://docs.truthlocks.com/fr/api-reference/machine-identity/agents/register.md) :

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/agents \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agent_type": "pipeline",
    "display_name": "CRM Enrichment Pipeline",
    "scopes": ["crm:contact.enrich", "data:read"]
  }'
```


## OpenAPI

````yaml fr/mint-openapi.yaml POST /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:
    post:
      tags:
        - Machine Identity
      summary: Créer une portée
      description: >-
        Crée une portée de permission personnalisée, limitée au locataire, pour
        un contrôle d'accès granulaire des agents.
      operationId: maip.scopes.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                action:
                  type: string
                  description: >-
                    Composant d'action de la portée (par exemple, "lire",
                    "approuver", "*")
                category:
                  type: string
                  description: Catégorie organisationnelle (par défaut "custom")
                description:
                  type: string
                  description: Description détaillée de ce que le scope accorde
                display_name:
                  type: string
                  description: Nom lisible par l'homme pour la portée
                resource:
                  type: string
                  description: >-
                    Composant de ressource de la portée (par exemple, "crm",
                    "payment")
              type: object
              required:
                - resource
                - action
      responses:
        '201':
          description: Portée créée
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  tenant_id:
                    type: string
                    format: uuid
                  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
        '400':
          description: Erreur de validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Authentification requise
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: La portée existe déjà
          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.