招待を取り消す

POST /v1/invitations/{invitation_id}:revoke · 権限 invitations:write

保留中の招待を取り消します。そのリンクは使用できなくなり、メールアドレスは消去されます。この書き込みは invitation.revoked として監査されます。

リクエスト

フィールド	型	必須	説明
`invitation_id`	path	はい	招待 ID（`inv_…`）。

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

レスポンス

200 OK と、取り消された招待を返します。

{
  "id": "inv_01j9xt9v3w4y8z0a2b4c6d8e0g",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "email": null,
  "role_ids": [
    "rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
  ],
  "application_id": null,
  "delivery": "link_only",
  "delivery_status": "not_sent",
  "status": "revoked",
  "send_count": 1,
  "last_sent_at": "2026-10-12T09:31:00.123456Z",
  "expires_at": "2026-10-19T09:31:00.123456Z",
  "accepted_user_id": null,
  "accepted_at": null,
  "revoked_at": "2026-10-12T10:00:00Z",
  "created_at": "2026-10-12T09:31:00.123456Z",
  "updated_at": "2026-10-12T09:31:00.123456Z",
  "version": 2
}

エラー

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

例

curl -i -X POST "https://api.eu.keenauth.com/v1/invitations/inv_01j9xt9v3w4y8z0a2b4c6d8e0g:revoke" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

このエンドポイントは個人データを扱います：組織のメンバーシップと招待。KeenAuth API における個人データでは、保存される内容、保持期間、削除方法について説明しています。いかなるフィールドにも特別な種類の個人データ（健康、生体情報、宗教、政治的意見、性的指向）を送信しないでください。