VERSION API REST API LIST API

TOKEN API

K2HR3 REST APIのトークン(TOKEN)に関連するAPI群です。

POST

Unscoped User Tokenの生成

ユーザ(USER)の Credential 情報を指定して、Unscoped User Tokenを生成します。

Scoped User Tokenの生成

ユーザ(USER)の Credential 情報もしくは、Unscoped User Tokenを指定し、テナント(TENANT)の権限を持つ Scoped User Tokenを生成します。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/user/tokens

Credential時

Content-Type: application/json

Unscoped User Token指定時

Content-Type: application/json
x-auth-token: U=<Unscoped User Token>

Request Body

Credential時

{
    auth: {
        tenantName:      <tenant name>,
        passwordCredentials:    {
            username:    <user name>
            password:    <pass phrase>
        }
    }
}

Unscoped User Token指定時

{
    auth: {
        tenantName:      <tenant name>,
    }
}

Response status

200、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
    scoped:     <true/false>
    token:      <token string>
}

PUT

Unscoped User Tokenの生成

ユーザ(USER)の Credential 情報を指定して、Unscoped User Tokenを生成します。

Scoped User Tokenの生成

ユーザ(USER)の Credential 情報もしくは、Unscoped User Tokenを指定し、テナント(TENANT)権限を持つ Scoped User Tokenを生成します。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/user/tokens?urlarg

Header

Credential時

Content-Type: application/json

Unscoped User Token指定時

Content-Type: application/json
x-auth-token: U=<Unscoped User Token>

URL Arguments

Credential時

Unscoped User Token指定時

Response status

200、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
    scoped:     <true/false>
    token:      <token string>
}

GET

Unscoped User TokenもしくはScoped User Tokenを指定して、利用できるテナント(TENANT)リストを取得します。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/user/tokens

Header

Content-Type: application/json
x-auth-token: U=<Unscoped User Token or Scoped User Token>

Response status

200、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
    scoped:     <true/false>
    user:       <user name>
    tenants:    [
        {
            name:       <tenant name>
            display:    <display tenant name>
        },
        ...
    ]
}

Unscoped User TokenもしくはScoped User Tokenを指定して、そのTokenが有効であるか確認をします。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/user/tokens

Header

Content-Type: application/json
x-auth-token: U=<Unscoped User Token or Scoped User Token>

Response status

204、40x

Response Body(JSON)

なし

VERSION API REST API LIST API