OAuth2 API リファレンス (1.1)
Download OpenAPI specification:Download
OAuth2は、アプリケーションがユーザに代わってクラウドBOTプラットフォームへのアクセスを取得できるようにするプロトコルです。
クラウドBOTは「The OAuth 2.0 Authorization Framework」RFCに沿った認可サーバAPIを部分的に提供します。
クラウドBOTのOAuth2認可機能を利用する場合、OAuth2の「認可コードフロー」を理解する必要があります。RFC「4.1. Authorization Code Grant」項を参照してください。
このドキュメントは、「認可コードフロー」で使用する認可サーバAPIの各種エンドポイントのリファレンスです。
認可リクエスト
あなたのアプリケーションが、ユーザに対してクラウドBOTアカウントへのアクセス認可をリクエストする時、このエンドポイントにページをリダイレクトすることによって、ユーザへの認可リクエスト画面が提供されます。
ユーザが認可リクエスト画面で認可または拒否をすると、redirect_uriパラメータのURLへリダイレクトされます。
この時、URLには以下のGETパラメータが付与されています。
code: 認可コード
state: ステート文字列
(error: ユーザが認可を拒否した場合のみ付与されます。)
https://yourdomain/callback?code={認可コード}&state={ステート文字列}
取得した認可コードを使って、アクセストークンの発行を行ってください。
query Parameters
| client_id required | integer あなたのアプリケーションを示すIDです。 |
| redirect_uri required | string Myアプリで登録したreidrect_uriと同一のURL |
| response_type required | string Value: "code" 「code」固定(認可コードフローを要求する) |
| scope required | string 認可を求める権限 |
| state | string ステート文字列の利用を推奨します。 |
Responses
認可リクエスト画面
Response samples
- 200
アクセストークンの発行およびリフレッシュ
認可コードを使用してアクセストークンを発行します。
また、リフレッシュトークンを利用してアクセストークンのリフレッシュを行うこともできます。
発行されたアクセストークンは、認可したユーザがアクセスできるすべてのBOTに対して同様にアクセスすることができます。招待を受けた別契約のBOTも対象になります。
Request Body schema: application/x-www-form-urlencoded
| grant_type required | string Enum: "authorization_code" "refresh_token" authorization_code: アクセストークンの発行 |
| client_id required | integer あなたのアプリケーションを示すIDです。 |
| client_secret required | string Myアプリで発行されたシークレット |
| redirect_uri | string Myアプリで登録したreidrect_uriと同一のURL |
| code | string 認可コード |
| refresh_token | string リフレッシュトークン |
Responses
トークンを発行しました。
Response samples
- 200
{- "username": "user@example.com",
- "token_type": "Bearer",
- "expires_in": 31536000,
- "access_token": "string",
- "refresh_token": "string"
}