SAML v2 Reconcile Lambda

When an SAML v2 identity provider is used to complete a federated login request, FusionAuth will use the configured linking strategy and well known SAML v2 attributes to reconcile the user. FusionAuth will attempt to match the user information returned from the SAML v2 identity provider to an existing user account or create a new one.

You may optionally utilize a lambda to customize the user and user registration during the authentication event.

It is common that the SAML attributes (claims) returned from the SAML IdP login request will contain custom attributes. In order to utilize these custom attributes you may wish to use a lambda to assist FusionAuth during the login request to copy these claims to appropriate fields on the FusionAuth user object.

When you create a new lambda using the FusionAuth administrative user interface, you will be provided an empty function to implement.

Lambda Structure

If you are using the API to create the lambda you will need to ensure your function has the following signature:

function reconcile(user, registration, samlResponse) {
  // Lambda code goes here
}

This lambda must contain a function named reconcile that takes three parameters. The parameters that the lambda is passed are:

• user - the FusionAuth User object. You can modify this, except the email or username attribute may not be modified after the user has been linked.
• registration - the FusionAuth UserRegistration object. You can modify this.

• samlResponse - the SAML v2 response object. This is read-only.

The two FusionAuth objects are well documented here in the User API and Registration API documentation. The SAML response object mimics the format of the XML document, but is designed to be much simpler to use than dealing with the DOM object model. Here is a list of the fields you have access to manipulate in the SAML response:

SAML Response Fields

samlResponse.assertion.attributes['firstName'] = [user.firstName];

Assigning The Lambda

Once a lambda is created, you may assign it to one or more SAML v2 IdPs in the IdP configuration.

Navigate to Settings -> Identity Providers and select your existing a SAML v2 configuration or click Add provider and select SAML v2 if it has not yet been configured.

Example Lambda

Here is an example of a simple Lambda that sets roles and attributes on the FusionAuth user from the SAML v2 response.

function reconcile(user, registration, samlResponse) {
  // Assign the roles to the user from the SAML attribute named 'roles'
  registration.roles = samlResponse.assertion.attributes['roles'] || [];
  // Set Assign a custom attribute from the SAML attribute named 'favoriteColor'
  registration.data.favoriteColor = samlResponse.assertion.attributes['favoriteColor'];

  // Create an event log of type 'Debug' when the lambda has Debug enabled
  console.debug('FusionAuth reconciled a User from a SAML v2 IdP and I helped!');
}

During development if you want to get a better idea of what your IdP is returning in the samlResponse object, you may print the contents of this object to the Event Log to help you write the lambda. Add the following line of code to your lambda to dump the entire object to an informational event log.

// Pretty print the samlResponse object to the Event Log
console.info(JSON.stringify(samlResponse, null, 2));