アクセストークンの取得
このメソッドは、アクセストークンをリクエストします。
URL
http[s]://<host>:<port>/configapi/v2/oauth/token
パラメータ
| パラメータ | 必須? | 説明 |
| grant_type | 必須 | 値は client_credentials である必要があります。 |
| client_id | 必須 | ログインID |
| client_secret | 必須 | ユーザー API シークレット |
リクエストの例
以下の HTTP POST リクエストは、https://example.com ウェブサービスのアクセストークンを要求するものです。client_id は、アクセストークンの発行対象となるアプリケーションに代わってユーザーを識別します。
POST /configapi/v2/oauth/token HTTP/1.1
Host: example.com
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=client-id&client_secret=qkDwDJlDfig2IpeuUZYKH1Wb8q1V0ju6sILxQQqhJ&tenant=example.com
アクセストークンの応答
アクセストークンのリクエストに対する成功レスポンスには、以下のパラメータを含む JSON OAuth 2.0 レスポンスが含まれます。
パラメータ
| パラメータ | 説明 |
| access_token | 要求されたアクセストークンです。呼び出し元アプリケーションは、このトークンを使用して、受信サービスに対して認証を行うことができます。 |
| token_type | トークンのタイプの値を示します。サポートされているタイプは Bearer のみです。Bearer トークンの詳細については、『OAuth 2.0 認証フレームワーク:Bearer トークンの使用法』(RFC 6750)をご参照ください。 |
| expires_in | アクセストークンの有効期間(秒単位)です。 |
応答の例
以下の例は、Web サービスへのアクセストークン取得リクエストに対する成功レスポンスを示しています。
{
"access_token":"eyJhbGciOiJSUzI1NiI5q9Jgt...6HznsvPWy7UP3MINA",
"token_type":"Bearer",
"expires_in":"3599",
}
アクセストークンを使用してリソースにアクセスする
access_token の取得に成功したら、そのトークンを Authorization ヘッダーに含めることで、Web API へのリクエストに使用することが可能になります。RFC 6750 では、保護されたリソースにアクセスするための HTTP リクエストにおいて、ベアラートークンを使用する方法について説明されています。
リクエストの例
GET /data HTTP/1.1
Host: example.com
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbW4t