Oracle^® ZFS Storage Appliance RESTful API ガイド、Release OS8.8.x

トークンの管理

永続的および非永続的な REST ログイントークンの作成、トークンのプロパティーの表示、およびトークンの削除を行うことができます。REST ログイントークンのプロパティーは、トークンが作成された後は読み取り専用です。返されたトークン値またはトークン ID を介してトークンにアクセスできます。

使用例 3  REST ログイントークンの作成

REST ログイントークンを作成するには、ユーザー名とパスワードが必要です。

トークン name を設定します。デフォルトでは、preserve の値は false であり、expiration の値は 900 です。preserve を true に設定する場合は、expiration を秒数に設定する必要があります。

結果の X-Auth-Session の値を必ず保存してください。詳細については、REST ログイントークンを参照してください。

リクエストの例:

POST /api/user/v2/users/test_user/preferences/tokens HTTP/1.1
Host: zfs-storage.example.com:215
X-Auth-User: test_user
X-Auth-Key: password-xxx
Content-Type: application/json

{"name": "Test Token"}

結果例:

HTTP/1.1 201 Created
...
X-Auth-Session: JjZJsZrVQfbZULyAuvSJjTftnBHCcQT

{
    "token": {
        "href": 
"/api/user/v2/users/test_user/preferences/tokens/fb65a127-a04c-4f58-bc52-efa884447efb", 
        "name": "Test Token",
        "token_username": "test_user",
        "preserve": false,
        "expiration": "2020-04-30T02:33:44Z",
        "id": "fb65a127-a04c-4f58-bc52-efa884447efb"
    }
}

リクエストの例:

POST /api/user/v2/users/test_user/preferences/tokens HTTP/1.1
Host: zfs-storage.example.com:215
X-Auth-User: test_user
X-Auth-Key: password-xxx
Content-Type: application/json

{"name": "Another Token", "preserve": true, "expiration": 3600}

結果例:

HTTP/1.1 201 Created
...
X-Auth-Session: pviHrthBGQhGZHoPuqxFQrDcCPZgwEK

{
    "token": {
        "href": 
"/api/user/v2/users/test_user/preferences/tokens/21f981ad-6221-4fb4-a7d1-dd5560256dfb", 
        "name": "Another Token",
        "token_username": "test_user",
        "preserve": true,
        "expiration": "2020-04-30T03:20:31Z",
        "id": "21f981ad-6221-4fb4-a7d1-dd5560256dfb"
    }
}

使用例 4  指定されたユーザーのすべてのトークンの一覧表示

リクエストの例:

GET /api/user/v2/users/test_user/preferences/tokens HTTP/1.1
X-Auth-Session: pviHrthBGQhGZHoPuqxFQrDcCPZgwEK

結果例:

{
    "tokens": [{
        "name": "Another Token",
        "token_username": "test_user",
        "preserve": true,
        "expiration": "2020-04-30T03:20:31Z",
        "id": "21f981ad-6221-4fb4-a7d1-dd5560256dfb",
        "href": "/api/user/v2/users/testuser1/preferences/tokens/21f981ad-6221-4fb4-a7d1-dd5560256dfb"
    },{
        "name": "Test Token",
        "token_username": "test_user",
        "preserve": false,
        "expiration": "2020-04-30T02:33:44Z",
        "id": "fb65a127-a04c-4f58-bc52-efa884447efb",
        "href": "/api/user/v2/users/testuser1/preferences/tokens/fb65a127-a04c-4f58-bc52-efa884447efb"
    }]
}

使用例 5  トークン値別の特定のトークンの一覧表示

リクエストの例:

GET /api/user/v2/users/test_user/preferences/tokens?token=pviHrthBGQhGZHoPuqxFQrDcCPZgwEK HTTP/1.1
X-Auth-Session: pviHrthBGQhGZHoPuqxFQrDcCPZgwEK

結果例:

{
    "token": {
        "href": 
"/api/user/v2/users/test_user/preferences/tokens/21f981ad-6221-4fb4-a7d1-dd5560256dfb", 
        "name": "Another Token",
        "token_username": "test_user",
        "preserve": true,
        "expiration": "2020-04-30T03:20:31Z",
        "id": "21f981ad-6221-4fb4-a7d1-dd5560256dfb"
    }
}

使用例 6  トークン ID 別の特定のトークンの一覧表示

GET /api/user/v2/users/test_user/preferences/tokens/21f981ad-6221-4fb4-a7d1-dd5560256dfb HTTP/1.1
X-Auth-Session: pviHrthBGQhGZHoPuqxFQrDcCPZgwEK

結果は前述の場合と同じです。

使用例 7  トークン値別のトークンの削除

リクエストの例:

DELETE /api/user/v2/users/test_user/preferences/tokens?token=pviHrthBGQhGZHoPuqxFQrDcCPZgwEK HTTP/1.1
X-Auth-Session: pviHrthBGQhGZHoPuqxFQrDcCPZgwEK

結果例:

HTTP/1.1 204 No Content

使用例 8  トークン ID 別のトークンの削除

DELETE /api/user/v2/users/test_user/preferences/tokens/21f981ad-6221-4fb4-a7d1-dd5560256dfb HTTP/1.1
X-Auth-Session: pviHrthBGQhGZHoPuqxFQrDcCPZgwEK