認証ページ
1. 概要
- ex)リクエストイメージ ※便宜上改行している。
インフォマートプラットフォームID(以下、PFID)の認証を行うためのページ。
インフォマートAPIを利用するユーザのブラウザに表示させる。
ユーザはこの認証ページにて、PFIDのユーザIDとパスワードを入力する。
認証が成功すると、利用システムが用意しているコールバックURLのページへリダイレクトする。
2. アクセス仕様
項目 | 内容 |
---|---|
プロトコル | HTTPS |
メソッド | GET |
URL | https://auth.infomart.co.jp/openam/oauth2/authorize?realm=/api |
3. リクエスト(HTTPS GET, UTF-8)
パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
---|---|---|---|---|---|
client_id | クライアントID | 文字列 | ○ | サービスの申請時に発行されたクライアントID。 |
|
redirect_uri | コールバックURL | 文字列 | ○ | PFIDの認証後、リダイレクトされるページのURL。 サービスの申請時に指定したURLと一致する必要がある。 |
|
response_type | レスポンスタイプ | 文字列 | ○ | 以下の固定値を指定する。 "code":許可コードのリクエスト |
|
state | ステートコード | 文字列 | 任意の文字列を指定。 |
||
scope | スコープ | 文字列 | ○ | 以下の固定値を指定する。 "openid profile email qualified":インフォマートAPIを利用 |
|
access_type | アクセス種別 | 文字列 | ○ | 以下の固定値を指定する。 "offline":リフレッシュトークンを取得 |
https://auth.infomart.co.jp/openam/oauth2/authorize?realm=/api
&client_id=sample_client_id
&redirect_uri=https%3a%2f%2fxxxx%2fcallback
&response_type=code
&state=sample_state_code
&scope=openid%20profile%20email%20qualified
&access_type=offline
4. コールバックURLへのリクエスト(HTTPS GET, UTF-8)
パラメータ名 | 名前 | 型 | 長さ・範囲 | 必須 | 備考 |
---|---|---|---|---|---|
code | 許可コード | 文字列 | ○ | ID認証が行われた際に発行されるコード。 アクセストークンの取得に使用する。 許可コードの有効期限は120秒。 有効期限が切れる前にアクセストークンの発行が必要になる。 |
|
state | ステートコード | 文字列 | 認証ページのリクエストに設定した値がそのまま設定される。 リクエストと一致を確認することで他者が成りすましで、リクエストを発行したりすることを防ぎ、セキュリティが向上する。 |
- ex)リクエストイメージ ※便宜上改行している。
https://xxxx/callback
?code=e1a82b2b-c612-4c2c-8a15-a2afc8e7b743
&state=sample_state_code
5. 処理詳細
5.1. 認証ページリクエスト
利用システムより認証サーバへ認証ページのリクエストを行う。
※認証ページへ発行するリクエストは「3.リクエスト(HTTPS GET, UTF-8)」を参照。
5.2. リクエストチェック
認証サーバにて利用システムからのリクエストをチェックする。
不備があった場合、リクエストエラーとなる。
5.3. 認証ページ表示
認証サーバは利用システムからのリクエストを元に利用ユーザーのブラウザに認証ページを表示する。
5.4. ユーザー入力
利用ユーザが認証ページにてユーザIDとパスワードを入力する。
5.5. 認証チェック
認証サーバは入力されたユーザとパスワードで認証チェックを行う。
認証に失敗した場合、認証エラーとなる。
5.6. コールバックURLリダイレクト
認証サーバがリクエストのコールバックURLで指定されたページへリダイレクトを行う。
※コールバックURLへ発行されるリクエストは「4.コールバックURLへのリクエスト(GET, UTF-8)」を参照。
6. 備考・補足
特になし。