機能概要
OAuth 2.0プロトコルを利用し、認可をおこないます。
機能詳細
OAuth 2.0プロトコルを利用し指定された認可エンドポイントで認可をおこない、有効なスコープとアクセストークンを取得し、保存します。
取得したアクセストークンを無効化するには、1715_ネットワーク/OAuth2トークン無効化を使用してください。
パラメーター
- 引数
-
認可エンドポイント 文字列データ
認可要求リクエストのエンドポイント。トークンリクエストURI 文字列データ
認可コードとトークンを交換するエンドポイント。クライアントID 文字列データ
クライアント識別子クライアントシークレット 文字列データ
クライアントシークレットスコープ 文字列データ
アクセストークンのスコープをスペース区切りのリストで指定する。オプションパラメーター
リダイレクトURI 文字列データ
認可要求リクエストの結果がリダイレクトされるURI※Windowsでは http://localhost:待受可能なポート を指定してください
Android/iOSでは、「https://prd-unifinity-storage.s3-ap-northeast-1.amazonaws.com/oauth2redirect」を経由して「jp.co.unifinity://oauth2redirect」にリダイレクトされます。トークン保存場所 Global : 他のUnifinityアプリケーションからもトークンが参照できます。
Local : ロジックを実行したUnifinityアプリケーションのみトークンが参照できます。レスポンスタイプ code/tokenを指定する(codeは、iOS/Androidで使用されます)
code : 認可エンドポイントへ認証コードを要求する
token : 認可エンドポイントへトークンを要求する
【注意】
トークンを削除する場合は、トークン保存場所としてGlobal/Localを指定します。
トークンの保存はGlobal/Localのスコープでのホストネーム毎に保存されます。
- 戻り値
- 文字列データ
- 戻り値は、JSON形式となり「ディクショナリー/JSON読込」で読み込んで利用します。
受信内容を返します。 - 成功時:
-
access_token アクセストークン token_type アクセストークンの種別 expires_in アクセストークンの有効期限 refresh_token リフレッシュ用のトークン scope
アクセストークンのスコープ
- 失敗時:
-
error エラー内容 error_description エラーの説明 error_uri エラーURI