Passer au contenu principal
POST
curl
Purge de nombreux gabarits en un seul appel. Fournissez soit une liste explicite d’identifiants, soit delete_all: true, éventuellement restreinte par les mêmes filtres que Lister les gabarits biométriques.

Corps de la requête

delete_all: true sans filtre purge chaque gabarit biométrique de l’application, et cette action est irréversible. Exécutez d’abord Compter les gabarits biométriques avec les mêmes filtres pour vérifier ce qui sera purgé.

Exemples

Les gabarits sont purgés un par un ; chaque résultat indique purged ou already_purged. Si un service de stockage biométrique est indisponible, l’appel renvoie 503 au premier gabarit en échec ; les gabarits purgés plus tôt dans la même requête restent purgés, le gabarit en échec passe à purge_failed (déjà exclu de la correspondance), et répéter la requête termine le travail.

Erreurs

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Corps

application/json
template_uuids
string<uuid>[]

Modèles à purger. Obligatoire sauf si delete_all est true. Les identifiants déjà purgés sont signalés comme already_purged.

Minimum array length: 1
delete_all
boolean
défaut:false

Lorsque la valeur est true, purge chaque modèle correspondant aux filtres ci-dessous (tous les modèles de l'application si aucun filtre n'est fourni). template_uuids est ignoré. Irréversible.

vendor_data
string

Uniquement avec delete_all : correspondance de sous-chaîne insensible à la casse sur le vendor_data de l'utilisateur propriétaire.

vendor_user_uuid
string<uuid>

Uniquement avec delete_all : correspondance exacte sur l'utilisateur propriétaire.

status
enum<string>

Uniquement avec delete_all.

Options disponibles:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

Uniquement avec delete_all.

Options disponibles:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

Uniquement avec delete_all.

retained_to
string<date-time>

Uniquement avec delete_all. Ne doit pas être antérieur à retained_from.

Réponse

Résultats de purge par modèle.

results
object[]
Dernière modification le 7 novembre 2026