Admin Portal リンクを取り消す

DELETE /v1/admin-portal-links/{link_id} · 権限 admin-portal-links:write

リンクを取り消します。このリンクが開いたポータルセッションはすべて直ちに終了します。すでに取り消されたリンクを取り消しても 204 を返し、新たな監査レコードは書き込まれません。取り消しは admin_portal_link.revoked として監査されます。

リクエスト

フィールド 型 必須 説明
link_id path はい リンク ID(apl_…)。

リクエスト本文はありません。

レスポンス

204 No Content。

エラー

HTTP code 発生条件
404 not_found この環境にリンクが存在しません。
401 unauthenticated 認証情報が不足しているか、無効または取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を経てから再試行してください。
503 service_unavailable 依存サービスが一時的に利用できません。Retry-After の期間を経てから再試行してください。

例

curl -i -X DELETE "https://api.eu.keenauth.com/v1/admin-portal-links/apl_01j9xv2c4d6e8f0g2h4j6k8m0n" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"