Validate and show information for token#
トークンの情報(有効期限と権限範囲を含む)を確認し、表示します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://identity.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://identity.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v3/auth/tokens
HTTPステータスコード#
正常時:200
エラー時:400, 401, 403, 404, 405, 413, 503
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| X-Auth-Token | header | string | 必須 | 管理者ユーザーが利用する有効な認証トークン |
| X-Subject-Token | header | string | 必須 | 認証用トークン 認証用のレスポンスはトークンIDをレスポンスボディではなく、このヘッダーに挿入して返却されます。 |
| nocatalog | query | string | 任意 | 指定される場合は、認証用のレスポンスはサービスカタログを省略します。デフォルトはこのパラメータは指定されません。 |
| allow_expired | query | boolean | 任意 | 指定される場合は、期限切れとなったトークンの取得を有効にします。省略する場合は、期限切れとなったトークンは404エラーを返却します。 |
レスポンスボディ(正常系)の説明#
| 名前 | Type | Description |
|---|---|---|
| X-Subject-Token | string | 認証用トークン 認証用のレスポンスはトークンIDをレスポンスボディではなく、このヘッダーに挿入して返却されます。 |
| domain | object | ドメインオブジェクト |
| methods | array | 認証方法 「password」、「token」、または両方です。トークンを取得するために使ったすべてのメソッドを表現します。 例えば、トークンはパスワード認証で取得された場合、「password」が表示されます。パスワード認証の後に、トークン交換があった場合は、「password」と「token」の両方が表示されます。Multi-factor authentication(MFA、多段階認証)と違って、このパラメータはユーザーを認証するための方法だけを表現します。認証段階を設定する責任はクライアントが決定します。 |
| links | object | ドメインリソースへのリンクURL |
| user | object | ユーザーオブジェクト |
| token | object | トークンオブジェクト |
| expires_at | string | トークンの有効期限 日時は以下の「ISO 8601」の形式で表示されます。 CCYY-MM-DDThh:mm:ss.sssZ 例: 2015-08-27T09:49:58.000000Z 「null」はトークンの有効期限がないことを表します。 |
| project | object | プロジェクトオブジェクト |
| catalog | array | カタログオブジェクト |
| roles | array | ロールオブジェクトの一覧 |
| audit_ids | array | 1つまたは2つの監査ID 監査IDとはランダムに生成されるURLに挿入可能な一意の文字列です。監査IDでトークンを追跡することができます。1つ目の監査IDは現在のトークンのIDです。 - トークンが違うスコープ、または同じスコープを持つトークンで交換される場合は、re-scoped token(スコープ再設定済みのトークン)です。 - re-scopedトークンの場合は、2つ目の監査IDはスコープ再設定の前のIDです。このIDを使って、権限を持たないユーザーにトークンIDを公開せずに、複数のリクエストおよびエンドポイントをまたがって、トークンを追跡することができます。 |
| issued_at | string | トークンの発行日時 「ISO 8601」の形式で表示されます。 CCYY-MM-DDThh:mm:ss.sssZ 例: 2015-08-27T09:49:58.000000Z |
| id | string | ユーザーのID ユーザー名を指定しない場合は、必須です。 |
レスポンス例#
{ "token": { "methods": [ "token" ], "expires_at": "2015-11-05T22:00:11.000000Z", "user": { "domain": { "id": "default", "name": "Default" }, "id": "10a2e6e717a245d9acad3e5f97aeca3d", "name": "admin", "password_expires_at": null }, "audit_ids": [ "mAjXQhiYRyKwkB4qygdLVg" ], "issued_at": "2015-11-05T21:00:33.819948Z" } }