Force.com Apex Code Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

SamlJitHandler Interface

Use this interface to control and customize Just-in-Time user provisioning logic during SAML single sign-on.

Namespace

Auth

Usage

To use custom logic for user provisioning during SAML single sign-on, you must create a class that implements Auth.SamlJitHandler. This allows you to incorporate organization-specific logic (such as populating custom fields) when users log in to Salesforce with single sign-on. Keep in mind that your class must perform the logic of creating and updating user data as appropriate, including any associated account and contact records.

In Salesforce, you specify your class that implements this interface in the SAML JIT Handler field in SAML Single Sign-On Settings. Make sure that the user you specify to run the class has “Manage Users” permission.

SamlJitHandler Methods

The following are methods for SamlJitHandler.

createUser(Id, Id, Id, String, Map<String,String>, String)

Returns a User object using the specified Federation ID. The User object corresponds to the user information and may be a new user that hasn’t t been inserted in the database or may represent an existing user record in the database.

Signature

public User createUser(Id samlSsoProviderId, Id communityId, Id portalId, String federationIdentifier, Map<String,String> attributes, String assertion)

Parameters

samlSsoProviderId
Type: Id
The ID of the SamlSsoConfig standard object.
communityId
Type: Id
The ID of the community. This parameter can be null if you’re not creating a community user.
portalId
Type: Id
The ID of the portal. This parameter can be null if you’re not creating a portal user.
federationIdentifier
Type: String
The ID Salesforce expects to be used for this user.
attributes
Type: Map<String,String>
All of the attributes in the SAML assertion that were added to the default assertion; for example, custom attributes. Attributes are case-sensitive.
assertion
Type: String
The default SAML assertion, base-64 encoded.

Return Value

Type: User

A User sObject.

Usage

The communityId and portalId parameter values may be null or an empty key if there is no community or portal configured with this organization.

updateUser(Id, Id, Id, Id, String, Map<String,String>, String)

Updates the specified user’s information. This method is called if the user has logged in before with SAML single sign-on and then logs in again, or if your application is using the Existing User Linking URL.

Signature

public void updateUser(Id userId, Id samlSsoProviderId, Id communityId, Id portalId, String federationIdentifier, Map<String,String> attributes, String assertion)

Parameters

userId
Type: Id
The ID of the Salesforce user.
samlSsoProviderId
Type: Id
The ID of the SamlSsoConfig object.
communityId
Type: Id
The ID of the community. This can be null if you’re not updating a community user.
portalId
Type: Id
The ID of the portal. This can be null if you’re not updating a portal user.
federationIdentifier
Type: String
The ID Salesforce expects to be used for this user.
attributes
Type: Map<String,String>
All of the attributes in the SAML assertion that were added to the default assertion; for example, custom attributes. Attributes are case-sensitive.
assertion
Type: String
The default SAML assertion, base-64 encoded.

Return Value

Type: void

SamlJitHandler Example Implementation

This is an example implementation of the Auth.SamlJitHandler interface. This code uses private methods to handle accounts and contacts (handleContact() and handleAccount()), which aren’t included in this example.