Access Token の発行 API

IdP は LINE WORKS が IdP のアクセストークンを発行するための API を作成します。ユーザーは API Request URL を LINE WORKS に登録します。

参考

  • OAuth 2.0 による SSO 7~8
  • OAuth 2.0 による API 認証 5~6

Developer Console > SSO > WORKS as SP の Access Token Return API に登録します。

図13 OAuth 2.0 による Access Token Return API の登録

図13 OAuth 2.0 による Access Token Return API の登録

注意

  • Access Token の発行時、セッション満了時間は expires_in の値により設定されます。
  • expires_in を設定していない場合、既定のログイン保持期間として、ウェブ ブラウザでは 24 時間、モバイルアプリおよび PC アプリでは 30 日に設定されます。

IdP は LINE WORKS からの API Request を受け取ったのち、認証システムで Authorization Code を検証してアクセストークンを発行し、Authorization Code を無効化します。その後、発行したアクセストークンを含め API Response を送信します。

API Request {#access-token-request}

LINE WORKS から Access Token Return API に送信されるリクエストは以下の通りです。

HTTP Request {#access-token-request-url}

POST {Access Token Return API Request URL}

注意

  • Access Token Return API の Request URL には SSL (https) を使用してください。
  • LINE WORKS のセキュリティポリシーにより、port 443 を使用する必要があります。

Header Parameters {#access-token-request-parameter}

HeaderTypeDescription
Content-TypeString"application/x-www-form-urlencoded"
required

Request Body {#access-token-request-body}

PropertyTypeDescription
grant_typeString"authorization_code" (固定値)
required
client_idStringDeveloper Console で登録した Client ID
required
client_secretStringDeveloper Console で登録した Client Secret
required
codeStringAuthorization Code
required

参考

  • API 利用時、connection timeout は 1 秒、read timeout は 3 秒です。

Response {#access-token-response}

IdP は LINE WORKS からの API リクエストに対する応答を返します。

Header Parameters {#access-token-response-header}

HeaderTypeDescription
Content-TypeString"application/json"
required

Response Body {#access-token-response-body}

PropertyTypeDescription
access_tokenStringAccess Token
required
refresh_tokenStringRefresh Token
token_typeString"Bearer" (固定値)
required
expires_inStringAccess Token の有効期間
required

Error Response Body {#access-token-response-error-body}

PropertyTypeDescription
errorStringエラーコード
required
error_descriptionStringエラー内容
required

Error Code {#access-token-response-error-code}

CodeMessageDescription
101access_denied認可されたクライアントからのリクエストでない
201invalid_requestRequest の必須項目に不足がある。またはデータ形式が不正
203unsupported_grant_type非対応の grant_type
301unauthorized_clientclient id と secret を用いた認証が失敗した
302invalid_authorizationAuthorization Code の検証に失敗した