FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-Minute Setup Guide
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • 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
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Roadmap
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
  • Login Methods
    • 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
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Authentication Tokens
    • Client Libraries
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • Ruby
      • Typescript
    • 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 Dup. Create
        • User Login Id Dup. 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 Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Advanced Registration Forms
      • Breached Password Detection
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • JSON Web Tokens
    • Key Master
    • Localization and Internationalization
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • Search And FusionAuth
    • Two Factor (pre 1.26)
    • User Control & Gating
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • 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. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Kafka Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Advanced Threat Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • SCIM-SDK Example
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Customizing
      • Troubleshooting
  • 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
  • Release Notes

    SAML v2 Populate lambda

    SAML v2 Populate lambda

    In order to handle complex integrations with SAML service providers, you can specify a lambda to be used by the FusionAuth SAML identity provider. This lambda will be invoked prior to the SAML response being sent back to the service provider.

    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 populate(samlResponse, user, registration) {
      // Lambda code goes here
    }

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

    • samlResponse - the SAML v2 response object

    • user - the FusionAuth User object

    • registration - the FusionAuth UserRegistration 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 applications in the SAML configuration. See the SAML tab in the Application configuration.

    Example lambda

    Here is an example of a simple Lambda that sets a few extra parameters into the SAML response from the User, including some custom data:

    
    function populate(samlResponse, user, registration) {
      // Set an attribute named 'roles' from the User assigned roles for this registration
      samlResponse.assertion.attributes['roles'] = registration.roles || [];
    
      // Set an attribute named 'favoriteColor' using the custom data attribute named 'favoriteColor'
      samlResponse.assertion.attributes['favoriteColor'] = [user.data.favoriteColor];
    }

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    © 2022 FusionAuth
    Subscribe for developer updates