SimpleSignInService
Amazonシンプルサインインフレームワークとやり取りするための主要なAPIを提供します。サードパーティアプリ開発者は、このAPIを呼び出して、シンプルサインインを使用したAmazonとのアカウントリンクによりユーザーをサインインするためのフローを制御します。
コンストラクタ
new SimpleSignInService()
new SimpleSignInService():
SimpleSignInService
戻り値
メソッド
getUserAndLinks()
staticgetUserAndLinks(identityProviderName):Promise<GetUserAndLinksResponse>
リクエスト元のアプリを介して、デバイスで現在アクティブなAmazonユーザーのシンプルサインイン関連データを取得するリクエストを開始します。レスポンスには、以下のデータが含まれます。
- アクティブなリンク済みアカウントのリスト、および各アカウントの新しいSSIトークン。
- AmazonユーザーのスコープID。トークン生成時にlinkTokenの範囲をAmazonユーザーに限定するためにアプリで使用されます。
パラメーター
identityProviderName
string
アプリにサインインしているユーザーを認証するために使用するIDプロバイダーの名前。これは、開発者コンソールでシンプルサインインのオンボーディング中に受け取ったIDです。
戻り値
Promise<GetUserAndLinksResponse>
解決時にユーザーIDとAmazonで作成された既存のリンクを含む応答を返すPromiseオブジェクト。
linkUserAccount()
staticlinkUserAccount(request):Promise<LinkUserAccountResponse>
ユーザーのアプリアカウントのアカウントリンクを開始します。このソリューションでは、Amazonとアプリアカウントの間の多対多マッピングが可能になります。1つのAmazonアカウントに複数のアプリアカウントをリンクさせることができ、また、1つのアプリアカウントに複数のAmazonアカウントを同時にリンクさせることもできます。
アカウントリンクを設定する前に、シンプルサインインクライアントがユーザー同意画面を表示してユーザーに同意を促します。ユーザーの同意を得る際、リンクデータとlinkTokenはシンプルサインインサーバーに保存されます。ユーザーがアカウントリンクへの同意を拒否した場合、リンクプロセスは中止され、ユーザーから受け取ったlinkTokenは破棄されます。
パラメーター
request
パートナーユーザーID、IDプロバイダー名、ユーザーログイン名、サードパーティアプリによって生成されたリンクトークン、サードパーティアプリによって生成されたリンク署名キーを含むリクエスト。
戻り値
Promise<LinkUserAccountResponse>
解決時に、作成されたリンクのリンクIDとリンク作成リクエストの成功コードを含む応答を返すPromiseオブジェクト。
recordMetricEvent()
staticrecordMetricEvent(request):Promise<RecordMetricsEventResponse>
指標の公開用に記録する必要があるイベントを開始します。シンプルサインインのビジネス指標レポートは、開発者コンソールの [レポート] タブでダウンロードできます。これらの指標は、SSIの統合によるビジネス価値や影響を把握するためのものです。
パラメーター
request
SSIイベント、ミリ秒単位のタイムスタンプ、SSIイベントが失敗した場合の失敗理由を含むリクエスト。
戻り値
Promise<RecordMetricsEventResponse>
解決時にリクエストの成功／失敗のステータスを返すPromiseオブジェクト。
showLoginSelection()
staticshowLoginSelection(loginNames):Promise<ShowLoginSelectionResponse>
ユーザーにログインオプションを表示する画面を開始します。このAPIを開始する前に、getUserAndLinks APIを使用して取得されるリンク済みアカウントごとに、アプリはユーザーが認識しやすい識別子（ログイン名／Eメールアドレス／プロファイル名）をアプリサーバーから取得し、このデータをリクエストに含めます。このデータは画面に表示され、リンクされたアプリアカウントをユーザーが認識しやすくするために使用されます。
パラメーター
loginNames
表示するログイン名とそのリンクIDマッピングのリスト。
戻り値
Promise<ShowLoginSelectionResponse>
解決時にユーザーの選択内容と、ログインに使用するように選択されたリンクIDを提供するPromiseオブジェクト。
Last updated: 2025年10月2日
