SAML v2 IdP Initiated API

This feature requires .

Available since 1.26.0

The SAML v2 IdP-Initiated Identity Provider allows an external IdP to send an unsolicited AuthN request to FusionAuth, which acts as the Service Provider (SP).

Integration Details#

The following values will likely be required by your SAML v2 IdP Initiated Identity Provider in order to trust FusionAuth as a relying party.

These values are autogenerated and viewable within the UI after creating the Identity Provider. They can be viewed by navigating to Settings -> Identity Providers -> SAMLv2 IdP Initiated -> View .

<base_url> is the URL for your FusionAuth instance, something like https://login.piedpiper.com.

<identityProviderId> is the Id of the Identity Provider, and will be a valid UUID.

<applicationId> is the Id of the application that is the target of the login, and will be a valid UUID.

Callback URL (ACS): <base_url>/samlv2/acs/<identityProviderId>/<applicationId>

Issuer: <base_url>/samlv2/sp/<identityProviderId>

Metadata URL: <base_url>/samlv2/sp/metadata/<identityProviderId>

Note: To receive a refresh token when completing the OAuth2 workflow when using an IdP initiated login, ensure you request the offline_access scope. To request a scope, add the following query parameter to your configured ACS in your IdP, ?scope=offline_access. When logging into the FusionAuth admin UI, this step is optional as the offline_access scope will be implicitly added.

Create a SAML v2 IdP Initiated Identity Provider#

Request#

Create a SAML v2 IdP Initiated Identity Provider using a randomly generated Id

POST/api/identity-provider

OpenAPI Spec

Create a SAML v2 IdP Initiated Identity Provider with the provided unique id

POST/api/identity-provider/{identityProviderId}

OpenAPI Spec

The type property in the request JSON indicates you are managing a SAML v2 IdP Initiated identity provider.

Request Parameters#

identityProviderId UUID optional Defaults to secure random UUID Immutable

The Id to use for the new Identity Provider. If an id is not provided, a secure random UUID is generated.

Request Body#

identityProvider.applicationConfiguration Map<UUID, Object> optional

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].createRegistration Boolean optional Defaults to true

Determines if a UserRegistration is created for the User automatically or not. If a user doesn't exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.

identityProvider.applicationConfiguration[applicationId].enabled Boolean optional Defaults to false

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.assertionDecryptionConfiguration.enabled Boolean optional Defaults to false Available since 1.55.1

Determines if FusionAuth requires encrypted assertions in SAML responses from the identity provider.

When true, SAML responses from the identity provider containing unencrypted assertions will be rejected by FusionAuth.

identityProvider.assertionDecryptionConfiguration.keyTransportDecryptionKeyId UUID optional Available since 1.55.1

The Id of the key stored in Key Master that is used to decrypt the symmetric key on the SAML response sent to FusionAuth from the identity provider. The selected Key must contain an RSA private key.

Required when identityProvider.assertionDecryptionConfiguration.enabled is true.

identityProvider.attributeMappings Map<String, String> optional Available since 1.65.0

A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.

Each key is the FusionAuth target field path and must begin with user. or registration.. Each value is the source expression in the identity provider response payload. A dot-notated value such as email or id_token.given_name is converted to a JSON Pointer. A value that starts with / is treated as a JSON Pointer as-is.

This property cannot be used with identityProvider.lambdaConfiguration.reconcileId.

This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.

This property defaults to an empty map.

Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored. Mappings to user.password do not set a password.

identityProvider.debug Boolean optional Defaults to false

Determines if debug is enabled for this provider. When enabled, an Event Log is created each time this provider is invoked to reconcile a login.

This is useful for debugging purposes, but is not intended to be left on during production. It should be enabled during integration or if you are experiencing an issue with this identity provider.

identityProvider.emailClaim String optional

The name of the email claim (attribute in the Assertion element) in the SAML response that FusionAuth uses to uniquely identity the user.

Required when identityProvider.useNameIdForEmail is false.

identityProvider.enabled Boolean optional Defaults to false

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.issuer String required

The EntityId (unique identifier) of the SAML v2 identity provider. This value should be provided to you. Prior to 1.27.1 this value was required to be a URL.

identityProvider.keyId UUID required Deprecated

The Id of the key stored in Key Master that is used to verify the SAML response sent back to FusionAuth from the identity provider. This key must be a verification only key or certificate (meaning that it only has a public key component).

Deprecated since 1.69.0

In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.

identityProvider.lambdaConfiguration.reconcileId UUID optional

The Id of a SAML reconcile lambda that is applied when the identity provider sends back a successful SAML response.

The specified Lambda Id must be of type SAMLv2Reconcile.

identityProvider.linkingStrategy String optional Defaults to LinkByEmail Available since 1.28.0

The linking strategy to use when creating the link between the SAML v2 IdP Initiated Identity Provider and the user.

Available since 1.65.0 You can only change this value when the identity provider is disabled. To change the linking strategy for an identity provider that is already enabled, disable the provider, change the value, and then re-enable the provider.

The possible values are:

CreatePendingLink - Do not automatically link, instead return a pending link identifier that can be used to link to an existing user.
Disabled - Disables linking automatically. You must use the API to create links. Available since 1.37.0
LinkAnonymously - Always create a link based upon the unique Id returned by the identify provider. A username or email is not required and will not be used to link the user. A reconcile lambda will not be used in this configuration.
LinkByEmail - Link to an existing user based upon email. A user will be created with the email returned by the identity provider if one does not already exist.
LinkByEmailForExistingUser - Only link to an existing user based upon email. A user will not be created if one does not already exist with email returned by the identity provider.
LinkByUsername - Link to an existing user based upon username. A user will be created with the username returned by the identity provider if one does not already exist.
LinkByUsernameForExistingUser - Only link to an existing user based upon username. A user will not be created if one does not already exist with username returned by the identity provider.

identityProvider.name String required

The name of this SAML v2 identity provider. This is only used for display purposes. Must be unique across all identity providers.

identityProvider.source String optional Defaults to System Available since 1.65.0

The source of this Identity Provider.

The maximum length is 191 characters.

This value is only used on create. If provided on update, it is ignored and the existing value is preserved.

identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0

The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.

identityProvider.tenantId UUID optional Available since 1.62.0

The unique Id of the Tenant.

Providing a value creates an identity provider scoped to the specified tenant, otherwise a global identity provider is created. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. Global identity providers can be used with any tenant.

This value is read-only once the identity provider is created.

identityProvider.type String required

This field must be set to SAMLv2IdPInitiated.

identityProvider.uniqueIdClaim String optional

The name of the unique claim in the SAML response that FusionAuth uses to uniquely link the user. If this is not set, the emailClaim will be used when linking user.

identityProvider.useNameIdForEmail Boolean optional

Whether or not FusionAuth will use the NameID element value as the email address of the user for reconciliation processing. If this is set to false, then the emailClaim property must be set.

identityProvider.usernameClaim String optional

The name of the claim in the SAML response that FusionAuth uses to identity the username. If this is not set, the NameId value will be used to link a user. This property is required when identityProvider.linkingStrategy is set to LinkByUsername or LinkByUsernameForExistingUser

identityProvider.verificationKeyIds Array<UUID> required Available since 1.69.0

The Ids of the keys stored in Key Master that are used to verify the SAML response sent back to FusionAuth from the identity provider. These keys must be verification-only keys or certificates (meaning that they only have a public key component).

In versions prior to 1.69.0, this field is not present; see identityProvider.keyId.

Example SAML v2 IdP Initiated Request JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "assertionDecryptionConfiguration": {
      "enabled": true,
      "keyTransportDecryptionKeyId": "ce0ca33d-3555-4b89-9777-0ef1276f7b26"
    },
    "debug": false,
    "emailClaim": "email",
    "enabled": true,
    "issuer": "http://hooli.com",
    "lambdaConfiguration": {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "linkingStrategy": "LinkByEmail",
    "name": "My SAML IdP Initiated provider",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "SAMLv2IdPInitiated",
    "uniqueIdClaim": "userId",
    "useNameIdForEmail": true,
    "usernameClaim": "username",
    "verificationKeyIds": [
      "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
      "6a3a08d9-137e-40fc-83ad-6e50afcfdae4"
    ]
  }
}

Response#

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
409	A conflict was encountered processing this request.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

identityProvider.applicationConfiguration Map<UUID, Object>

The configuration for each Application that the identity provider is enabled for.

identityProvider.applicationConfiguration[applicationId].createRegistration Boolean

identityProvider.applicationConfiguration[applicationId].enabled Boolean

Determines if this identity provider is enabled for the Application specified by the applicationId key.

identityProvider.assertionDecryptionConfiguration.enabled Boolean Available since 1.55.1

Determines if FusionAuth requires encrypted assertions in SAML responses from the identity provider.

When true, SAML responses from the identity provider containing unencrypted assertions will be rejected by FusionAuth.

identityProvider.assertionDecryptionConfiguration.keyTransportDecryptionKeyId UUID Available since 1.55.1

The Id of the key stored in Key Master that is used to decrypt the symmetric key on the SAML response sent back to FusionAuth from the identity provider. The selected Key must contain an RSA private key.

identityProvider.attributeMappings Map<String, String> Available since 1.65.0

A map of attribute mappings applied during user reconciliation when a reconcile Lambda is not configured.

Each key is the FusionAuth target field path and begins with user. or registration.. Each value is the source expression from the identity provider response payload.

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

Mappings that resolve to null, cannot be extracted, or cannot be written to the target field are ignored at runtime. Mappings to user.password do not set a password.

identityProvider.debug Boolean Available since 1.7.3

Determines if debug is enabled for this provider. When enabled, each time this provider is invoked to reconcile a login an Event Log will be created.

identityProvider.emailClaim String

The name of the email claim (attribute in the Assertion element) in the SAML response that FusionAuth uses to uniquely identity the user.

identityProvider.enabled Boolean

Determines if this provider is enabled. If it is false then it will be disabled globally.

identityProvider.id UUID

The Id of the provider.

identityProvider.insertInstant Long

The instant that the provider was added to the FusionAuth database.

identityProvider.issuer String

The EntityId (unique identifier) of the SAML v2 identity provider.

identityProvider.lastUpdateInstant Long

The instant that the provider was updated in the FusionAuth database.

identityProvider.keyId UUID Deprecated

The Id of the key stored in KeyMaster that is used to verify the SAML response sent back to FusionAuth from the identity provider. This key must be a verification only key or certificate (meaning that it only has a public key component).

Deprecated since 1.69.0

identityProvider.lambdaConfiguration.reconcileId

The Id of a SAML reconcile lambda that is applied when the identity provider sends back a successful SAML response.

identityProvider.linkingStrategy String optional Defaults to LinkByEmail Available since 1.28.0

The linking strategy to use when creating the link between the SAML v2 IdP Initiated Identity Provider and the user.

The possible values are:

CreatePendingLink - Create pending link.
Disabled - Disables linking automatically. Available since 1.37.0
LinkAnonymously - Anonymous Link.
LinkByEmail - Link on email. Create the user if they do not exist.
LinkByEmailForExistingUser - Link on email. Do not create the user if they do not exist.
LinkByUsername - Link on username. Create the user if they do not exist.
LinkByUsernameForExistingUser - Link on username. Do not create the user if they do not exist.

identityProvider.name String

The name of this SAML v2 identity provider. This is only used for display purposes.

identityProvider.source String Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0

identityProvider.tenantId UUID Available since 1.62.0

The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.

identityProvider.type String

This field will be SAMLv2IdPInitiated.

identityProvider.uniqueIdClaim String

The name of the unique claim in the SAML response that FusionAuth uses to uniquely link the user. If this is not set, the emailClaim will be used when linking user.

identityProvider.useNameIdForEmail Boolean

Whether or not FusionAuth will use the NameID element value as the email address of the user for reconciliation processing.

identityProvider.usernameClaim String

identityProvider.verificationKeyIds Array<UUID> Available since 1.69.0

In versions prior to 1.69.0, this field is not present; see identityProvider.keyId.

Example SAML v2 IdP Initiated Response JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "assertionDecryptionConfiguration": {
      "enabled": true,
      "keyTransportDecryptionKeyId": "ce0ca33d-3555-4b89-9777-0ef1276f7b26"
    },
    "debug": false,
    "emailClaim": "email",
    "enabled": true,
    "id": "e13afb7b-77c7-4451-9c07-897d38f4fb3d",
    "insertInstant": 1595361142909,
    "issuer": "http://www.hooli.com",
    "lastUpdateInstant": 1595361143101,
    "linkingStrategy": "LinkByEmail",
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "lambdaConfiguration": {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "name": "My SAML IdP Initiated provider",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "SAMLv2IdPInitiated",
    "uniqueIdClaim": "userId",
    "useNameIdForEmail": true,
    "usernameClaim": "username",
    "verificationKeyIds": [
      "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
      "6a3a08d9-137e-40fc-83ad-6e50afcfdae4"
    ]
  }
}

Retrieve a SAML v2 IdP Initiated Identity Provider#

Request#

Retrieve an Identity Provider by Id

GET/api/identity-provider/{identityProviderId}

OpenAPI Spec

Request Parameters#

identityProviderId UUID required

The unique Id of the SAML v2 IdP Initiated Identity Provider to retrieve.

Response#

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.