カスタムドメインを削除

DELETE /v1/custom-domains/{custom_domain_id} · 権限 custom-domains:write

カスタムドメインを削除します。ドメインは released 状態になり、そのドメインでのサインインは停止し、名前は 30 日間隔離されます(他の環境は追加できません)。プライマリドメインと、環境の発行者として使われているドメインは削除できません。先に別のドメインをプライマリに設定してください。すでに解放されたドメインを削除しても、プラットフォームのレジストリでの解放が繰り返されるだけです。

リクエスト

フィールド 型 必須 説明
custom_domain_id string はい カスタムドメインの ID(cdom_…)。
If-Match header はい 必須。ドメインの ETag。欠落時は 428、一致しない場合は 412。

リクエストボディはありません。

レスポンス

204 No Content。

エラー

HTTP code 発生条件
404 not_found カスタムドメインが存在しないか、別の環境に属しています。
409 custom_domain_in_use そのドメインはプライマリドメインか、環境の発行者です。
409 domain_in_use_by_rp_id そのドメインは、ある接続のパスキー rpId か、実行中の rpId 移行の旧 rpId です。先に パスキーの rpId を変更で rpId を移動してください。
412 precondition_failed If-Match がドメインの現在のバージョンと一致しません。
428 precondition_required If-Match がありません。
503 service_unavailable プラットフォームのドメインレジストリ、または環境の発行者情報が一時的に利用できません。
401 unauthenticated 認証情報がないか、無効または取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を過ぎてから再試行してください。

例

curl -X DELETE https://api.eu.keenauth.com/v1/custom-domains/cdom_01j9xk3m7q8r2s4t6v8w0y2z4a \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "3"'