ジャンプ先

• リクエスト
• レスポンス
• 例

指定されたアクセス/リフレッシュ・トークンを取り消します。

投稿

/oauth2/rest/token/revoke

リクエスト

サポートされているメディア・タイプ

• application/x-www-form-urlencoded

問合せパラメータ

• identityDomain(optional): string
  トークンの取消しをリクエストしているアイデンティティ・ドメインの代替名。指定した場合、ヘッダー・パラメータ'x-oauth-identity-domain-name'は必要ありませんが、ヘッダーがこのパラメータより優先されます。

ヘッダー・パラメータ

• authorization: string
  clientID:clientSecretのBase64でエンコードされたヘッダー。
• x-oauth-identity-domain-name: string
  トークンの取消しをリクエストしているアイデンティティ・ドメイン。

フォーム・パラメータ

• chaining_level(optional): string
  これにより、必要な取消しのレベルが決まります。次の可能な値を持つことができます
  NONE --> 指定されたトークンのみを取り消します。
  RELATED_CONSENT --> 関連する承認とともにトークンを取り消します。
  RELATED_TOKENS --> 関連するリフレッシュ/アクセス・トークンとともにトークンを取り消します。
  ノート:
  ACCESS_TOKENの場合、関連するトークンとはその親リフレッシュ・トークンのことです。
  REFRESH_TOKENの場合、関連するトークンとは、このリフレッシュ・トークンを使用して作成されたすべてのアクセス・トークンのことです。

  デフォルト値: NONE

  指定できる値: [ "RELATED_CONSENT", "RELATED_TOKENS", "NONE" ]
• token: string
  クライアントが取消しを希望するトークン。
• token_type(optional): string
  取消しのために送信されるトークンのタイプ。

  デフォルト値: NONE

  指定可能な値: [ "REFRESH_TOKEN", "ACCESS_TOKEN", "NONE" ]

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200 レスポンス

取消しに成功しました

本文()

ルート・スキーマ: ResponseObj

型: object

ソースを表示

• status(optional): string
  操作のステータス

  例: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"status of the operation",
            "example":"success"
        }
    }
}

400 レスポンス

不正なリクエスト

本文()

ルート・スキーマ: ErrorCode

型: object

ソースを表示

• errorCode(optional): string
  生成されたエラー・コード
• errorDesc(optional): string
  翻訳されたエラーの説明
• secErrorDesc(optional): string
  セカンダリ・エラー・メッセージ

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code Generated"
        },
        "errorDesc":{
            "type":"string",
            "description":"Translated Error Description"
        },
        "secErrorDesc":{
            "type":"string",
            "description":"Secondary Error Message"
        }
    }
}

先頭に戻る

例

cURLサンプル・リクエスト

この例では、特定のリフレッシュ・トークンを取り消すサンプル・リクエストを示します

curl --location --request POST '<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token/revoke' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-oauth-identity-domain-name: DemoDomain' \
--header 'Authorization: Basic RGVtb0NsaWVudElkOndlbGNvbWUx' \
--header 'Cookie: JSESSIONID=NysahaoNLyc13HzjEh93gJmwbY4HnMetJQY33RE8_ZdBpzpw7kdr!-472705583' \
--data-urlencode 'token=LCbzQggeRM1EMgprtKrHuQ%3D%3D%7EcsLp2lL9J03orCX0dTvBySFAXG4Yi%2BI%2FOq80
ChZzVsz1BrME2GEg9Kuk6aShduv0K%2F8Yzhs6F4RCOdXgO1uZi1u3V544Hf%2FziaoJFZGDr4UmfkLHByMTJYWTJXfR%2F
MUQkkDjffRAlox1vVjztUbhB1uKMkZWE%2FhTYHCp1pkc2zNJC7j7KQaIF%2BkNfg8GPS%2FdjeLo7i99%2B%2Bifb%2BKq
GTnaJWOr2JSm7XApoGlX9dwBzM8EHdO4IQNPYDxkvtQLajVxlRhK5ZnL3F29wBD4yOuXqg%3D%3D'

cURLサンプル・レスポンス

{
    "status": "success"
}

cURLの取消しのサンプル

curl --location --request POST '<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token/revoke' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'x-oauth-identity-domain-name: DemoDomain' \
--header 'Authorization: Basic RGVtb0NsaWVudElkOndlbGNvbWUx' \
--header 'Cookie: JSESSIONID=NysahaoNLyc13HzjEh93gJmwbY4HnMetJQY33RE8_ZdBpzpw7kdr!-472705583' \
--data-urlencode 'token=LCbzQggeRM1EMgprtKrHuQ%3D%3D%7EcsLp2lL9J03orCX0dTvBySFAXG4Yi%2BI%2FOq80
ChZzVsz1BrME2GEg9Kuk6aShduv0K%2F8Yzhs6F4RCOdXgO1uZi1u3V544Hf%2FziaoJFZGDr4UmfkLHByMTJYWTJXfR%2F
MUQkkDjffRAlox1vVjztUbhB1uKMkZWE%2FhTYHCp1pkc2zNJC7j7KQaIF%2BkNfg8GPS%2FdjeLo7i99%2B%2Bifb%2BKq
GTnaJWOr2JSm7XApoGlX9dwBzM8EHdO4IQNPYDxkvtQLajVxlRhK5ZnL3F29wBD4yOuXqg%3D%3D

curl --location --request POST '<ManagedServerHost>:<ManagedServerPort>/oauth2/rest/token/revoke?identityDomain=DemoDomain' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic RGVtb0NsaWVudElkOndlbGNvbWUx' \
--header 'Cookie: JSESSIONID=NysahaoNLyc13HzjEh93gJmwbY4HnMetJQY33RE8_ZdBpzpw7kdr!-472705583' \
--data-urlencode 'token=LCbzQggeRM1EMgprtKrHuQ%3D%3D%7EcsLp2lL9J03orCX0dTvBySFAXG4Yi%2BI%2FOq80
ChZzVsz1BrME2GEg9Kuk6aShduv0K%2F8Yzhs6F4RCOdXgO1uZi1u3V544Hf%2FziaoJFZGDr4UmfkLHByMTJYWTJXfR%2F
MUQkkDjffRAlox1vVjztUbhB1uKMkZWE%2FhTYHCp1pkc2zNJC7j7KQaIF%2BkNfg8GPS%2FdjeLo7i99%2B%2Bifb%2BKq
GTnaJWOr2JSm7XApoGlX9dwBzM8EHdO4IQNPYDxkvtQLajVxlRhK5ZnL3F29wBD4yOuXqg%3D%3D'

先頭に戻る