アクセス認可

外部サイト向け認可フロー(認可コードフロー)
認可コード([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_request400 (Bad request)リクエストが必須のパラメータを含んでいない。サポートしていないパラメータないしパラメータ値を含む、あるいは形式に問題がある。
invalid_grant400 (Bad request)提供された認可コードが不正、有効期限切れ、失効している、他のクライアントに対して発行されたものである。
invalid_client400 (Bad request)指定されたクライアントが不正である。
クライアントが未登録である場合に設定される。
unauthorized_client400 (Bad request)クライアントは指定した方法で認可を得られるように設定されていない。
unsupported_grant_type400 (Bad request)認可サーバは指定された方法によるアクセストークンの発行をサポートしていない。
maintenance503 (Service Unavailable)メンテナンス中の場合(セゾンコネクト)
maintenance_resource503 (Service Unavailable)メンテナンス中の場合(リソースサーバ)
temporarily_unavailable503 (Service Unavailable)一時的な過負荷によってリクエストを扱うことができない。
server_error500 (Internal Server Error)その他のサーバサイドが原因のエラー。
Language
Click Try It! to start a request and see the response here!