アクセストークン取得

モジュール

toyotaconnected-auth-client-if

クラス

AuthClient

アクセストークンを新規取得する機能を提供します。

コンストラクタ

コンストラクタ名	説明
AuthClient	AuthClient() Parameters:なし

var auth_client = new AuthClient()

メソッド一覧

メソッド名	説明
requestAccessToken(clientId, clientSecret, scope, cognitoDomain)	クライアント認証基盤（Cognito）からアクセストークンを新規取得する

メソッド

requestAccessToken

クライアント認証基盤（Cognito）からアクセストークンを新規取得する機能を提供します。

パラメータ

パラメータ	型	必須	不正値	説明
clientId	String	〇	空文字	CognitoのアプリクライアントID
clientSecret	String	〇	空文字	Cognitoのアプリクライアントシークレット
scope	String	〇	空文字、形式不正（[文字列+“/”+文字列]以外）	Cognitoのリソースサーバのスコープ（例："ttt/scope"）
cognitoDomain	String	〇	空文字	Cognitoのドメイン（例："testnormalauth.auth.us-east-2.amazoncognito.com"））

戻り値

型	説明
Object	以下の項目が格納される。

プロパティ	型	説明
accessToken	String	アクセストークン(base64エンコードされた値)
tokenType	String	トークン種別　（例：”Bearer”）
expiresIn	Number	有効期限　（例：3600）

サンプル

[HTML]

<script src = "./toyotaconnected-auth-client-if.bundle.js"></script>


[利用するjs内]

async function getAccessToken(){
  try {

    const auth_client = new AuthClient()
    
    // アクセストークンを取得
    let tokenData = await auth_client.requestAccessToken(clientId, clientSecret, scope, cognitoDomain)
    
    // 取得したtokenData内からaccessTokenプロパティの値を取得する
    let accessToken = tokenData.accessToken

  } catch (e) {
    //例外処理　アクセストークン要求失敗
    if (e instanceof AuthServiceError) {
        console.log(e.message)
    } 
    else {
        //例外処理
    }
  }
}

例外クラス

AuthServiceError

プロパティ

プロパティ名	型	説明
errorCode	String	エラー内容に応じたエラーコードが格納される。詳細はエラーコード仕様参照
message	String	エラー内容に応じたエラーメッセージが格納される。詳細はエラーメッセージ仕様参照

エラーコード仕様

フォーマット

[エラーコード(数値3桁)]

エラーコード一覧

エラーコード	説明
001	入力値不正
002	通信異常(Cognito呼び出し時にHTTPステータス200以外)
003	Cognito呼び出し時のリクエストタイムアウト(設定値のタイムアウト秒数が経過)
999	その他本ライブラリ内エラー

エラーメッセージ仕様

フォーマット

[エラー詳細文言]':'[エラー情報]

エラー詳細文言一覧

エラー詳細文言	説明
Invalid request parameter	入力値不正
Communication error	通信異常(Cognito呼び出し時にHTTPステータス200以外)
Request Timeout	Cognito呼び出し時のリクエストタイムアウト(設定値のタイムアウト秒数が経過)
Unexpected error	その他本ライブラリ内エラー

例：Invalid request parameter:scope=''

設定値

設定値	値	説明
TIME_OUT	30000	リクエストタイムアウト秒数（ミリ秒）

補足：　設定値を変更する場合は、.envファイルの設定値を変更し再びWebPack化を行う。