Apex 開発者ガイド
jNewer Version Available
SamlJitHandler インターフェース
名前空間
使用方法
SAML シングルサインオン時にユーザープロビジョニングのカスタムロジックを使用するには、Auth.SamlJitHandler を実装するクラスを作成する必要があります。これにより、ユーザーがシングルサインオンで Salesforce にログインするときに、組織固有のロジック (カスタム項目の自動入力など) を組み込むことができます。クラスは、関連付けられた取引先レコードと取引先責任者レコードを含め、ユーザーデータを作成および更新するロジックを必要に応じて実行する必要があります。
Salesforce で、[SAML シングルサインオン設定] の [SAML JIT ハンドラー] 項目にこのインターフェースを実装するクラスを指定します。クラスを実行するよう指定するユーザーに「ユーザーの管理」権限があることを確認します。
SamlJitHandler のメソッド
SamlJitHandler のメソッドは次のとおりです。
createUser(samlSsoProviderId, communityId, portalId, federationId, attributes, assertion)
署名
public User createUser(Id samlSsoProviderId, Id communityId, Id portalId, String federationId, Map<String,String> attributes, String assertion)
パラメーター
- samlSsoProviderId
- 型: Id
- SamlSsoConfig 標準オブジェクトの ID。
- communityId
- 型: Id
- Experience Cloud サイトの ID。Experience Cloud ユーザーを作成しない場合、このパラメーターは null にできます。
- portalId
- 型: Id
- ポータルの ID。ポータルユーザーを作成しない場合、このパラメーターは null にできます。
- federationId
- 型: String
- このユーザーに使用されると Salesforce が想定する ID。
- attributes
- 型: Map<String, String>
- SAML アサーションのうち、デフォルトのアサーションに追加されたすべての属性 (カスタム属性など)。属性では、大文字と小文字が区別されます。
- アサーションが暗号化されると、Sfdc.SamlAssertion という鍵を持つ値として保存される復号化されたアサーションが属性の対応付けに含まれます。
- assertion
- 型: String
- Base-64 エンコードされたデフォルトの SAML アサーション。
- アサーションが暗号化されると、このパラメーターも暗号化されます。復号化されたアサーションにアクセスするには、属性の対応付けの Sfdc.SamlAssertion という鍵を確認します。
戻り値
型: User
User sObject。
使用方法
この組織に Experience Cloud サイトまたはポータルが設定されていない場合、communityId および portalId パラメーター値は null または関連付けられた鍵になる可能性があります。
updateUser(userId, samlSsoProviderId, communityId, portalId, federationId, attributes, assertion)
署名
public void updateUser(Id userId, Id samlSsoProviderId, Id communityId, Id portalId, String federationId, Map<String,String> attributes, String assertion)
パラメーター
- userId
- 型: Id
- Salesforce ユーザーの ID。
- samlSsoProviderId
- 型: Id
- SamlSsoConfig オブジェクトの ID。
- communityId
- 型: Id
- Experience Cloud サイトの ID。Experience Cloud ユーザーを更新しない場合、この型は null にできます。
- portalId
- 型: Id
- ポータルの ID。ポータルユーザーを更新しない場合、この型は null にできます。
- federationId
- 型: String
- このユーザーに使用されると Salesforce が想定する ID。
- attributes
- 型: Map<String,String>
- SAML アサーションのうち、デフォルトのアサーションに追加されたすべての属性 (カスタム属性など)。属性では、大文字と小文字が区別されます。
- アサーションが暗号化されると、Sfdc.SamlAssertion という鍵を持つ値として保存される復号化されたアサーションも属性の対応付けに含まれます。
- assertion
- 型: String
- Base-64 エンコードされたデフォルトの SAML アサーション。
- アサーションが暗号化されると、このパラメーターも暗号化されます。復号化されたアサーションにアクセスするには、属性の対応付けの Sfdc.SamlAssertion という鍵を確認します。
戻り値
型: void