アクセス認可

外部サイト向け認可フロー(認可コードフロー) 認可コード([TEA002])/クライアントID/クライアントシークレットを用いて、アクセス認可を行う。 認可成功の場合、アクセストークン/リフレッシュトークンを発行する。 TEA004

RESPONSE

項目名(論理)

項目名(物理)

属性

最大桁数

[byte]

必須

項目説明

備考

アクセストークン

access_token

半角英数記

64

発行されたアクセストークン。

アクセストークン有効期間

expires_in

半角数(数値)

10

アクセストークンの有効期間を表す秒数。付加されていなければ無期限。

3600という値が付加されていた場合、サーバによってレスポンスが生成されてから1時間後にアクセストークンが失効することを表す。

リフレッシュトークン

refresh_token

半角英数記

64

発行されたリフレッシュトークン。
同一のエンドユーザのアクセス許可を使って新しいアクセストークンを取得するのに利用される。

トークンタイプ

token_type

半角英数記

64

トークンを使用したリソースアクセスの際に使用する形式を示す。
"bearer"または"mac"を返却する。

エラーコード

error

半角英数記

32

発生したエラー内容を示すコード。

※エラー時の場合のみ必須
(この場合、他の項目はすべて無しとなる)
※エラーコードの値は、「API処理結果コード」を参照のこと。

スコープ

scope

半角英数記

可変

アクセスを許可する範囲

IDトークン

id_token

半角英数記

可変

JWT(JSON Web Token)形式で返却する。
※ IDトークンの形態については「IDトークンについて」をご参照ください。

TEA001にて”scope”に”openid”を含めなかった場合、IDトークンは返却されません。

API処理結果コード

パラメータ "error" の値

HTTP status code

説明

200

正常終了

invalid_request

400 (Bad request)

リクエストが必須のパラメータを含んでいない。サポートしていないパラメータないしパラメータ値を含む、あるいは形式に問題がある。

invalid_grant

400 (Bad request)

提供された認可コードが不正、有効期限切れ、失効している、他のクライアントに対して発行されたものである。

invalid_client

400 (Bad request)

指定されたクライアントが不正である。
クライアントが未登録である場合に設定される。

unauthorized_client

400 (Bad request)

クライアントは指定した方法で認可を得られるように設定されていない。

unsupported_grant_type

400 (Bad request)

認可サーバは指定された方法によるアクセストークンの発行をサポートしていない。

maintenance

503 (Service Unavailable)

メンテナンス中の場合(セゾンコネクト)

maintenance_resource

503 (Service Unavailable)

メンテナンス中の場合(リソースサーバ)

temporarily_unavailable

503 (Service Unavailable)

一時的な過負荷によってリクエストを扱うことができない。

server_error

500 (Internal Server Error)

その他のサーバサイドが原因のエラー。

Language
Click Try It! to start a request and see the response here!