アクセストークン発行
1. 概要
- ex)リクエストイメージ
APIを利用するためのアクセストークンとリフレッシュトークンを発行する。
利用システムは取得したアクセストークンとリフレッシュトークンを保存して再利用することで、継続的にAPIを利用することができる。
2. アクセス仕様
項目 | 内容 |
---|---|
プロトコル | HTTPS |
メソッド | POST |
URL | https://auth.infomart.co.jp/openam/oauth2/access_token?realm=/api |
3. リクエスト(HTTPS GET, UTF-8)
パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
---|---|---|---|---|---|
grant_type | 権限種別 | 文字列 | ○ | 以下の固定値を指定する。 "authorization_code":認証コード |
|
code | 許可コード | 文字列 | ○ | コールバックURLで取得した許可コード。 | |
redirect_uri | コールバックURL | 文字列 | ○ | ||
client_id | クライアントID | 文字列 | ○ | サービス利用申請時に発行されたクライアントID。 | |
client_secret | クライアントシークレットID | 文字列 | ○ | サービス利用申請時に発行されたクライアントシークレットID。 |
POST https://auth.infomart.co.jp/openam/oauth2/access_token?realm=/api HTTP/1.1
Host: auth.infomart.co.jp
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
code=e1a82b2b-c612-4c2c-8a15-a2afc8e7b743
redirect_uri=https%3a%2f%2fxxxx%2fcallback
client_id=sample_client_id
client_secret=sample_secret
4. レスポンス(JSON, UTF-8)
成功時
要素名・階層 | 要素内容 | 型 | 必須 | 備考 |
---|---|---|---|---|
scope | スコープ | 文字列 | ○ | アクセストークンの持つスコープ。 |
exires_in | 有効期限 | 数字 | ○ | アクセストークンの有効期限(単位:秒) |
token_type | 種類 | 文字列 | ○ | アクセストークンの種類。 以下の固定値を返却する。 "Bearer" |
access_token | アクセストークン | 文字列 | ○ | 発行されたアクセストークン。 有効期限は5分となっている。 |
refresh_token | リフレッシュトークン | 文字列 | ○ | アクセストークンの再発行に使用するリフレッシュトークン。 有効期限は31日となっている。 |
- ex)リクエストイメージ ※便宜上改行している。
{
"scope":"openid profile email qualified",
"expires_in":300,
"token_type":"Bearer",
"access_token":"db36aeb3-021e-4a51-aaa6-b94c0da4542e",
"refresh_token":"f21b49b0-31b0-4441-8cc9-0ef7e14ae738"
}
5. 処理詳細
5.1. アクセストークン発行リクエスト
利用システムより認証サーバへアクセストークンの発行リクエストを行う。
※アクセストークン発行処理へ発行するリクエストは「3.リクエスト(HTTPS GET, UTF-8)」を参照。
5.2. リクエストチェック
認証サーバにて利用システムからのリクエストをチェックする。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。
5.3. アクセストークン・リフレッシュトークン発行
認証サーバにてアクセストークンとリフレッシュトークンを発行し、レスポンスとして返却する。
6. 備考・補足
特になし。