FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
  • 5-Minute Setup Guide
  • Release Notes
  • Core Concepts
    • Overview
    • Users
    • Roles
    • Groups
    • Entity Management
    • Registrations
    • Applications
    • Tenants
    • Identity Providers
    • Key Master
    • SCIM
    • Search
    • Authentication and Authorization
    • Integration Points
    • Localization and Internationalization
    • Editions and Features
    • Roadmap
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Licensing
    • Monitoring
    • Proxy Setup
    • Securing
    • Technical Support
    • Troubleshooting
    • Upgrading
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Tutorial
  • APIs
    • Overview
    • Authentication
    • Errors
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Kafka
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM EnterpriseUser
      • SCIM Group
      • SCIM Service Provider Config.
      • SCIM User
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • Webhooks
  • Client Libraries
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • Node
    • OpenAPI
    • PHP
    • Python
    • Ruby
    • Typescript
  • Themes
    • Overview
    • Examples
    • Helpers
    • Localization
    • Template Variables
  • Email & Templates
    • Overview
    • Configure Email
    • Email Templates
    • Email Variables
    • Message Templates
  • Events & Webhooks
    • Overview
    • Writing a Webhook
    • Securing Webhooks
    • Events
      • Overview
      • Audit Log Create
      • Event Log Create
      • JWT Public Key Update
      • JWT Refresh
      • JWT Refresh Token Revoke
      • Kickstart Success
      • User Action
      • User Bulk Create
      • User Create
      • User Create Complete
      • User Deactivate
      • User Delete
      • User Delete Complete
      • User Email Update
      • User Email Verified
      • User IdP Link
      • User IdP Unlink
      • User Login Failed
      • User Login Id Duplicate Create
      • User Login Id Duplicate Update
      • User Login New Device
      • User Login Success
      • User Login Suspicious
      • User Password Breach
      • User Password Reset Send
      • User Password Reset Start
      • User Password Reset Success
      • User Password Update
      • User Reactivate
      • User Registration Create
      • User Registration Create Complete
      • User Registration Delete
      • User Registration Delete Complete
      • User Registration Update
      • User Registration Update Complete
      • User Registration Verified
      • User Two Factor Method Add
      • User Two Factor Method Remove
      • User Update
      • User Update Complete
  • Example Apps
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • PHP
    • Python
    • Ruby
  • Lambdas
    • Overview
    • Apple Reconcile
    • Client Cred. JWT Populate
    • Epic Games Reconcile
    • External JWT Reconcile
    • Facebook Reconcile
    • Google Reconcile
    • HYPR Reconcile
    • JWT Populate
    • LDAP Connector Reconcile
    • LinkedIn Reconcile
    • Nintendo Reconcile
    • OpenID Connect Reconcile
    • SAML v2 Populate
    • SAML v2 Reconcile
    • SCIM Group Req. Converter
    • SCIM Group Resp. Converter
    • SCIM User Req. Converter
    • SCIM User Resp. Converter
    • Sony PSN Reconcile
    • Steam Reconcile
    • Twitch Reconcile
    • Twitter Reconcile
    • Xbox Reconcile
  • Identity Providers
    • Overview
    • Apple
    • Epic Games
    • External JWT
      • Overview
      • Example
    • Facebook
    • Google
    • HYPR
    • LinkedIn
    • Nintendo
    • OpenID Connect
      • Overview
      • Azure AD
      • Discord
      • Github
    • Sony PlayStation Network
    • Steam
    • Twitch
    • Twitter
    • SAML v2
      • Overview
      • ADFS
    • SAML v2 IdP Initiated
      • Overview
      • Okta
    • Xbox
  • Messengers
    • Overview
    • Generic Messenger
    • Kafka Messenger
    • Twilio Messenger
  • Connectors
    • Overview
    • Generic Connector
    • LDAP Connector
    • FusionAuth Connector
  • Self Service Account Mgmt
    • Overview
    • Updating User Data & Password
    • Add Two-Factor Authenticator
    • Add Two-Factor Email
    • Add Two-Factor SMS
    • Customizing
    • Troubleshooting
  • Advanced Threat Detection
    • Overview
  • Integrations
    • Overview
    • CleanSpeak
    • Kafka
    • Twilio
  • OpenID Connect & OAuth 2.0
    • Overview
    • Endpoints
    • Tokens
  • SAML v2 IdP
    • Overview
    • Google
    • Zendesk
  • Plugins
    • Plugins
    • Writing a Plugin
    • Custom Password Hashing
  • Guides
    • Overview
    • Advanced Registration Forms
    • Breached Password Detection
    • Multi-Factor Authentication
    • Multi-Tenant
    • Passwordless
    • Securing Your APIs
    • Silent Mode
    • Single Sign-on
  • Tutorials
    • Overview
    • User Control & Gating
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
    • Setup Wizard & First Login
    • Register/Login a User
    • Start and Stop FusionAuth
    • Authentication Tokens
    • Key Rotation
    • JSON Web Tokens
    • Prometheus Setup
    • Switch Search Engines
    • Two Factor (pre 1.26)
  • Reference
    • CORS
    • Configuration
    • Data Types
    • Known Limitations
    • Password Hashes

    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

    • registration - the FusionAuth UserRegistration object

    • samlResponse - the SAML v2 response object

    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]

    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.

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

    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

    © 2021 FusionAuth
    Subscribe for developer updates