メインコンテンツへスキップ
POST
curl
1回の呼び出しで複数のテンプレートを削除します。明示的なIDのリストまたはdelete_all: trueのいずれかを指定します。必要に応じて、生体認証テンプレートの一覧取得と同じフィルターで対象を絞り込めます。

リクエストボディ

フィルターなしでdelete_all: trueを指定すると、アプリケーション内のすべての生体認証テンプレートが削除され、元に戻すことはできません。先に同じフィルターで生体認証テンプレートの件数取得を実行し、削除対象を確認してください。

例

テンプレートは1件ずつ削除され、各結果ではpurgedまたはalready_purgedが返されます。生体認証ストアが利用できない場合、最初に失敗したテンプレートの時点でリクエストは503を返します。同じリクエスト内でそれより前に削除されたテンプレートは削除されたままとなり、失敗したテンプレートはpurge_failedに移行します(照合の対象からはすでに除外されています)。リクエストを再度実行すると処理が完了します。

エラー

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ボディ

application/json
template_uuids
string<uuid>[]

完全に削除するテンプレート。delete_allがtrueでない限り必須です。すでに削除済みのIDはalready_purgedとして報告されます。

Minimum array length: 1
delete_all
boolean
デフォルト:false

trueの場合、以下のフィルターに一致するすべてのテンプレートを完全に削除します(フィルターを指定しない場合は、アプリケーションのすべてのテンプレートが対象です)。template_uuidsは無視されます。元に戻すことはできません。

vendor_data
string

delete_allの場合のみ: 所有ユーザーのvendor_dataに対する、大文字と小文字を区別しない部分文字列一致です。

vendor_user_uuid
string<uuid>

delete_allを指定した場合のみ: 所有者であるユーザーとの完全一致。

status
enum<string>

delete_allの場合のみ。

利用可能なオプション:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

delete_allの場合のみ。

利用可能なオプション:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

delete_allの場合のみ。

retained_to
string<date-time>

delete_allの場合のみ。retained_fromより前の値は指定できません。

レスポンス

テンプレートごとのパージ結果です。

results
object[]
最終更新日 2026年11月1日