Token authentication with explicit unscoped authorization#

スコープがないことを明確に指定し、トークンを認証します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://identity.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://identity.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/v3/auth/tokens

HTTPステータスコード#

正常時:201

エラー時:400, 401, 403, 404, 405, 409, 413, 415, 503

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
nocatalog query string 任意 認証のレスポンスでカタログを省略するかどうかを指定します。デフォルトでは、カタログが表示されます。
methods body array 必須 認証方法
トークン認証の場合は「token」を指定します。
auth body object 必須 認証情報のオブジェクト
token body object 必須 トークンのオブジェクト
トークン認証が利用されます。トークン認証は、認証のスコープを変更する場合に、よく利用されます。
audit_ids body array 必須 1つまたは2つの監査ID
監査IDとはランダムに生成されるURLに挿入可能な一意の文字列です。監査IDでトークンを追跡することができます。1つ目の監査IDは現在のトークンのIDです。
- トークンが違うスコープ、または同じスコープを持つトークンで交換される場合は、re-scoped token(スコープ再設定済みのトークン)です。
- re-scopedトークンの場合は、2つ目の監査IDはスコープ再設定の前のIDです。このIDを使って、権限を持たないユーザーにトークンIDを公開せずに、複数のリクエストおよびエンドポイントをまたがって、トークンを追跡することができます。
scope body string 任意 認証のスコープ
- unscopedの場合は、明確にスコープを指定せずに、トークンをリクエストします。認証とスコープがないレスポンスが返却されます。スコープを指定しない、かつユーザーにデフォルトのプロジェクトが設定されていない場合のリクエストと同じ動作です。
- unscopedを明確に指定してリクエストせずに、デフォルトのプロジェクトが設定されている場合は、ユーザーのデフォルトのプロジェクトのスコープが設定されるトークンが返却されます。
id body string 必須 トークンのID
identity body object 必須 アイデンティティのオブジェクト

レスポンスボディ(正常系)の説明#

名前 Type Description
X-Subject-Token string 認証用トークン
認証用のレスポンスはトークンIDをレスポンスボディではなく、このヘッダーに挿入して返却されます。

リクエスト例#

{
    "auth": {
        "identity": {
            "methods": [
                "token"
            ],
            "token": {
                "id": "'$OS_TOKEN'"
            }
        },
        "scope": "unscoped"
    }
}

レスポンス例#

{
    "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"
    }
}