デフォルトの IDP の構成

サードパーティ ID プロバイダー (IDP) で Shopper API Access and Login (SLAS) を使用しており、SLAS でサポートされていない IDP を使用したい場合は、SLAS のデフォルト IDP 機能を使用して IDP と通信できます。

このガイドでは、SLAS Admin API または UI を使用して、SLAS でデフォルト IDP を構成するために必要な手順について説明します。

SLAS Admin API の registerIdentityProvider エンドポイントを使用して、デフォルト IDP を構成するリクエスト例を確認してみましょう。

デフォルトの IDP を構成するには、サポートされている IDP と同じプロパティが必要です。

加えて、IDP の name は接頭辞 default で始まる必要があります。この接頭辞の後に文字を追加するか、default-linkedin のような単一のダッシュを使用することで、複数のデフォルト IDP をテナントに関連付けることができます。

oidcClaimMapper プロパティも指定する必要があります。これは、IDP のトークンクレームを SLAS の必要な IDP キーにマッピングするために使用されます。これは文字列のリストであり、各文字列の形式は $KEY=$VAL です。ここで、 $KEY は必須の SLAS IDP キー、$VAL は対応する IDP トークンクレーム名です。

次のキーはマッピングしなければなりません。

  • accessToken: アクセストークンの値。
  • accessTokenTTL: アクセストークンの TTL (有効期限)。
  • refreshToken: リフレッシュトークンの値。
  • idToken: ID トークンの値。
  • subject: 件名。買い物客の一意の識別子です。
  • userId: これも件名です。買い物客の一意の識別子です。
  • email: 買い物客の E メール。
  • familyName: 買い物客の姓。
  • givenName: 買い物客の名。
  • name: 買い物客の氏名。

IDP トークンレスポンスで対応するクレームが見つからない場合、認証は失敗します。

IDP が Open ID Connect Discovery プロトコルをサポートしている場合、SLAS はデフォルト IDP の自動構成を試みることができます。

wellKnownUrl プロパティは、IDP の Open ID Connect Discovery エンドポイントの URL です。useWellKnown プロパティは、SLAS がその Discovery エンドポイントを使用してデフォルトの IDP 自動構成を試行するかどうかを示すブール値です。