コンテンツにスキップ

Token の失効(旧インターフェース)



POST /api/v1/offline_token/temporary_token/revoke

概要

旧フローでは一時オフライン Token キャッシュを無効化します。現在のバージョンには、新しい Token 形式との互換性制限があります。

呼び出し前の準備と使用手順

これは旧インターフェースであり、過去のドキュメントは 2026-05-31 に公開終了を予定しています。現在もソースコードには残っていますが、デプロイサイトで公開されているかどうかは実際のバージョンによります。新しい統合では、ワンタイム authCode の作成/交換フローを使用します。互換性が確認済みの旧 custom. プレフィックスを持ち、旧署名方式で解析できる Token のみがキャッシュ削除の対象になります。現在の公開ルートでは Token の種類が渡されないため、プレフィックスのない新バージョンの RS256 Token では失効の成功を保証できず、一般的な内部エラーが返る可能性があります。リトライによる成功を期待したり、他の形式に独自に改造したりして、失効確認の代わりにしないでください。互換形式に対して true が正常に返されると、この Token の本ワークスペースにおけるオフライン認可キャッシュが削除されます。以降の使用では再検証が必要となり、無効になっている必要があります。開始済みまたは完了済みのリクエストは、これによって取り消されることはありません。キャッシュがすでに存在しない場合でも、互換 Token は true を返すことがあります。未交換の code にはワンタイム認証コードの失効を使用してください。ただし、code を交換した後に code を失効させても Token には影響しません。短期アクセスが必要な場合は、作成時に expires を制御し、最終的な expiresAt に従って期限を確認してください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
token string Y 失効対象の完全な Token 文字列。必須です。authCode ではありません。新バージョンのプレフィックスなし Token には現在、失効の互換性制限があります。
null を許可: False
例: custom.<LEGACY-HS256-JWT>
取得または入力方法: 旧フローで保持している一時 customToken からそのまま取得します。この例はプレースホルダーにすぎないため、自分の対象 Token に置き換えてください。対象が現在のワークスペースに属し、このインターフェースと互換性のある旧形式であることを先に確認してください。

パラメータ補足説明

現在の失敗パスは常に 401 OfflineTokenFailed を返すわけではありません。一部の解析失敗、ワークスペース横断、または未認識のプレフィックスの場合は 500 InternalServerError を返します。このページでは実際の処理経路に基づいて説明しており、ソースコードのコメントにある「新旧 Token の互換性」を検証済みの動作として扱っていません。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/offline_token/temporary_token/revoke' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"token":"custom.<LEGACY-HS256-JWT>"}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示します。

フィールド 型 説明
content boolean 互換解析が成功し、キャッシュ削除フローが完了した場合にのみ true を返します。Token や削除件数は返しません。
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している パラメータ解析失敗 パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトではない 一部の json ファイル形式エラー 単一の JSON オブジェクトを送信してください。
401 ft.OfflineTokenFailed Token が 3 セグメントの JWT ではなく、旧プレフィックスと JWT にも分割できない ログイン不要 token の検証失敗 authCode や不完全な文字列を誤って送信していないか確認してください。自分でプレフィックスを補わないでください。
500 ft.InternalServerError 新バージョンのプレフィックスなし Token の署名検証互換性失敗、または Token 解析/ワークスペース不一致/サポートされないプレフィックスのパスが現在の例外処理の欠陥を引き起こした場合。キャッシュ処理の失敗の可能性もあります 内部エラー これに基づいて失効が成功したと判断することはできません。対象の形式、所属ワークスペース、有効期限を確認し、traceId を保持して管理者に確認を依頼してください。現在のバージョンでは互換パスを別途修正する必要があります。

フィードバック

このページは役に立ちましたか?