発行済みの Service Account Token を直ちに失効させます。
POST /api/v1/forward/service_account_tokens/{auth_token_id}/revoke
失効させた Token は直ちに無効になり、その Token を使用した後続の業務リクエストは拒否されます。Token が漏えいした可能性がある場合や、エンドユーザーセッションが早期終了した場合に使用します。
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer <Service Account Key> |
| Content-Type | はい | application/json |
パスパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| auth_token_id | string | はい | 失効させる Token の一意の ID。Token 作成レスポンスの auth_token_id。 |
リクエストボディ
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| target_credential_id | string | いいえ | 対象を正確に特定するための、作成レスポンスの credential_id。 |
| target_expires_at | string | いいえ | 対象を正確に特定するための、作成レスポンスの expires_at（RFC 3339 形式）。 |
| reason | string | いいえ | 監査用の失効理由。 |
リクエスト例
レスポンス例
HTTP 200 OK
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
| revoked | boolean | 失効に成功したかどうか。常に true。 |
エラー
| HTTP | Type | Code | 条件 |
|---|---|---|---|
| 400 | invalid_request_error | - | リクエストボディが無効、または target_expires_at が有効な RFC 3339 時刻ではない。 |
| 401 | authentication_error | - | Service Account Key が無効または期限切れ、あるいは別の種類の認証情報を使用。 |
| 404 | not_found_error | - | 対象 Token が存在しない、または現在の Service Account に属していない。 |
| 409 | conflict_error | - | 条件に複数の Token が一致。target_credential_id または target_expires_at を追加して対象を特定してください。 |
注意事項
- 失効は取り消せません。アクセスを続けるには新しい Token を作成してください。
- 同じ Service Account で発行された Token のみ失効できます。
- Key が漏えいした可能性がある場合は Token を失効させ、Qoder コンソールのエンタープライズ認証情報ページで Service Account Key もローテーションしてください。