next

OAuth 2.0 Token Introspection Endpoint

概要

トークンの内容を取得するAPIのエンドポイントです。 RFC7662を実装しています。

トークンのIssuerかAudienceがCellURLと等しい場合のみ結果を返します。

必要な権限

なし

制限事項

  • リクエストヘッダのAcceptは無視される
  • リクエストヘッダのContent-Typeは全てapplication/x-www-form-urlencodedとして扱う
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする

リクエスト

リクエストURL

{CellURL}/__introspect

メソッド

POST

リクエストヘッダ

項目名概要書式必須有効値
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {Token}
Basic {Base64String}		○Bearerの場合、認証トークンは認証トークン取得APIで取得したアクセストークン。UnitマスタートークンかUnitユーザトークン、もしくは、トークンのSchemaがリクエストボディで指定するtokenのSchemaと一致する場合のみtokenの情報を取得可能。
Basicの場合、ユーザ名とパスワードは、Unitの設定でIntrospection用に設定されたもの、もしくは、CellURLとトークンを指定。CellURLとトークンの場合は、クライアント認証がOKかつCellURLがtokenのSchemaと一致する場合のみtokenの情報を取得可能
Content-Typeリクエストボディの形式を指定するapplication/x-www-form-urlencoded×省略時は[application/x-www-form-urlencoded]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う

リクエストボディ

項目名概要書式必須有効値
tokenトークンString○認証トークン取得APIで取得したアクセストークンかリフレッシュトークン

リクエストサンプル

token=AA~(省略)

レスポンス

ステータスコード

200

レスポンスヘッダ

項目名概要備考
Content-Typeapplication/json

レスポンスボディ

項目名概要型備考
activeトークンが有効かどうかboolean
client_idクライアントIDstringpersoniumではトークンのschema
exp有効期限integerJanuary 1 1970 UTCからの秒数
iat発行時刻integerJanuary 1 1970 UTCからの秒数
subトークンの主体stringpersoniumではトークンのsubject
audトークンのオーディエンスstringpersoniumではトランスセルトークンにおけるtarget
issトークンの発行者stringトークンを発行したCellのURL
p_rolesトークンに含まれるロールのリストlist of stringpersonium独自仕様

レスポンスサンプル

有効なトークンの場合

{
  "active": true,
  "exp": 1544059820,
  "iat": 1543973420,
  "sub": "https://cell1.unit1.example/#account",
  "aud": "https://cell2.unit1.example/",
  "iss": "https://cell1.unit1.example/",
  "p_roles": ["https://cell1.unit1.example/__role/__/role1","https://cell1.unit1.example/__role/__/role2"]
}

無効なトークンの場合

{
  "active": false,
}

エラーメッセージ一覧

エラーメッセージ一覧を参照

cURLサンプル

curl "https://cell1.unit1.example/__introspect" -X POST -i \
-H 'Authorization:Basic username:password' \
-H 'Content-Type:application/x-www-form-urlencoded' \
-H 'Accept:application/json' \
-d 'token=RA~(省略)'
← パスワード変更(\__mypassword)Cell公開鍵取得 →