招待を取り消す
POST /fapi/v1/organizations/{org_id}/invitations/{invitation_id}:revoke · 環境のサインインホストから呼び出します
保留中の招待を取り消します。応答は取り消された招待で、その宛先のメールアドレスは削除済みです(email は null)。保留中ではない招待(承諾済み、期限切れ、または既に取り消し済み)の場合は、422 invitation_invalid が返されます。
ログイン中のユーザーの、Origin が完全一致する __Host-idp_session Cookie、または第一者アプリのフロント API アクセストークン(DPoP 証明を添えた Authorization: DPoP <token>。フロント API アクセストークン を参照)が必要です。ユーザーは、組織の有効なメンバーであり、idp_members:invite 権限を持っている必要があります。メンバーでないユーザーには 404 not_found が返され、権限のないメンバーには 403 insufficient_permissions が返されます。特権ロールを含む招待を取り消せるのは、管理者ロールを持つメンバーのみです(403 role_not_assignable)。
@keenauth/js を使用する場合: await keenauth.organizations.revokeInvitation(orgId, invitationId)。
リクエスト
ヘッダー:
| ヘッダー | 必須 | 説明 |
|---|---|---|
Idp-Client |
はい | SDK の識別子。 |
Origin |
Cookie を使う場合は必須 | https://<sign-in host>。 |
org_id: 組織の識別子(org_…)。invitation_id: 招待の識別子(inv_…)。招待 の id です。
ボディはありません。
レスポンス
200 OK で、招待と ETag: "<version>" が返されます。
エラー
| ステータス | コード | 発生条件 |
|---|---|---|
| 401 | unauthenticated |
有効なセッション Cookie またはトークンがありません。 |
| 403 | insufficient_permissions |
ユーザーが組織内で idp_members:invite を持っていません。 |
| 403 | role_not_assignable |
招待に特権ロールが含まれており、ユーザーが管理者ロールを持っていません。 |
| 403 | origin_not_allowed |
Origin が一致しません。 |
| 404 | not_found |
このユーザーに対して該当する組織または招待がありません。存在しない識別子、形式が不正な識別子、他者の識別子も同じ応答になります。 |
| 409 | organization_disabled |
組織が無効化されているか、削除保留中(organization_pending_deletion)です。 |
| 422 | invitation_invalid |
招待が保留中ではありません。 |
| 503 | service_unavailable |
一時的に利用できません。Retry-After の後に再試行してください。 |
例
curl -X POST "https://example.keenauth.app/fapi/v1/organizations/org_01jbz6x8kq3m2n4p5r6s7t8v9a/invitations/inv_01jbz6x8kq3m2n4p5r6s7t8v9d:revoke" \
-H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
-H "Origin: https://example.keenauth.app" \
-b cookies.txt
{
"id": "inv_01jbz6x8kq3m2n4p5r6s7t8v9d",
"email": null,
"role_ids": ["rol_01jbz6x8kq3m2n4p5r6s7t8v9w"],
"delivery": "email",
"delivery_status": "sent",
"status": "revoked",
"send_count": 1,
"last_sent_at": "2026-11-03T10:00:00Z",
"expires_at": "2026-11-10T10:00:00Z",
"accepted_user_id": null,
"accepted_at": null,
"revoked_at": "2026-11-03T11:00:00Z",
"created_at": "2026-11-03T10:00:00Z",
"updated_at": "2026-11-03T11:00:00Z",
"version": 2
}
個人データ
このエンドポイントは、組織のメンバーシップと招待という個人データを扱います。KeenAuth API の個人データ では、保存される内容、保存期間、削除方法について説明しています。どのフィールドにも、特別な種類の個人データ(健康、生体情報、宗教、政治的意見、性的指向)を送信しないでください。