SAML v2 Reconcile Lambda

    SAML v2 Reconcile lambda

    When an SAML v2 identity provider is used to complete a federated login request FusionAuth will use well known SAML v2 attributes to reconcile user.

    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 assist FusionAuth during the login request to reconcile these claims to the FusionAuth user.

    When you create a new lambda using the FusionAuth UI we will provide you an empty function for you to implement. 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 [Map<String, List<String>>]

    A map of the attributes of the user. This is sometimes call the claims of the user. Since SAML attributes can be multi-valued, you will need to wrap single values in Arrays like this:

    
samlResponse.assertion.attributes['firstName'] = [user.firstName];
    samlResponse.assertion.conditions.audiences [Array<String>]

    A list of the audiences for this SAML response. By default, the audience or issuer, in that order, from the corresponding SAML identity provider configuration are used.

    samlResponse.assertion.conditions.notBefore [Long]

    The instant that this assertion starts being valid. This is the number of milliseconds since Epoch UTC.

    samlResponse.assertion.conditions.notOnOrAfter [Long]

    The instant that this assertion stops being valid. This is the number of milliseconds since Epoch UTC.

    samlResponse.assertion.issuer [String]

    The issuer of this SAML assertion. This defaults to the issuser from the corresponding SAML identity provider configuration.

    samlResponse.assertion.subject.nameID.format [String] Deprecated

    The NameID format for the id of the subject (user). FusionAuth uses the emailaddress format specified by the SAML specifications. It is not recommended that you change this unless you know what you are doing.

    Removed in 1.28.0

    samlResponse.assertion.subject.nameID.id [String] Deprecated

    The NameID id of the subject (user). This defaults to the user’s email address. It is not recommended that you change this unless you know what you are doing.

    Removed in 1.28.0

    samlResponse.assertion.subject.nameIDs [Array] Available since 1.28.0

    The list of NameId objects.

    Prior to version 1.28.0, this field was a single entry but has since been converted to an array.

    samlResponse.assertion.subject.nameIDs[x].format [String] Available since 1.28.0

    The NameID format for the id of the subject (user). FusionAuth uses the urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress format specified by the SAML specifications by default. It is not recommended that you change this unless you know what you are doing.

    samlResponse.assertion.subject.nameIDs[x].id [String] Available since 1.28.0

    The NameID id of the subject (user). This defaults to the user’s email address. It is not recommended that you change this unless you know what you are doing.

    samlResponse.assertion.subject.confirmation.inResponseTo [String]

    This is the ID from the SAML request. It is not recommended that you change this unless you know what you are doing.

    samlResponse.assertion.subject.confirmation.method [String]

    The confirmation method FusionAuth uses for the subject (user). This default to Bearer. It is not recommended that you change this unless you know what you are doing.

    samlResponse.assertion.subject.confirmation.notBefore [Long]

    The instant that this assertion’s subject starts being valid. This is the number of milliseconds since Epoch UTC.

    samlResponse.assertion.subject.confirmation.notOnOrAfter [Long]

    The instant that this assertion’s subject stops being valid. This is the number of milliseconds since Epoch UTC.

    samlResponse.assertion.subject.confirmation.recipient [String]

    The recipient of the subject. This defaults to the callback URL (ACS).

    samlResponse.destination [String]

    The destination of the SAML response. This defaults to the callback URL (ACS).

    samlResponse.id [String]

    A unique identifier for the SAML response that is generated by FusionAuth.

    samlResponse.inResponseTo [String]

    This is the ID from the SAML request. It is not recommended that you change this unless you know what you are doing.

    samlResponse.issueInstant [Long]

    The instant that this assertion was created. This is the number of milliseconds since Epoch UTC.

    samlResponse.issuer [String]

    This is the issuer of the SAML response. This defaults to the name of this FusionAuth deployment.

    samlResponse.status.code [String]

    The status code of the SAML response. Whenever the lambda is called, this will always be Success.

    samlResponse.status.message [String]

    The status message of the SAML response. Whenever the lambda is called, this will always be null.

    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));

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.