Logo / Docs

SAML v2 IdP Initiated

FusionAuth Reactor logo

This feature is only available in paid plans. Please visit our pricing page to learn more.

Overview

This API has been available since 1.26.0

The SAML v2 IdP Initiated IdP initiated Identity Provider allows an external IdP to send an unsolicited AuthN request when FusionAuth is acting as the Service Provider (or 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>/<applicaitonId>

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

API Key Authentication
Create a SAML v2 IdP Initiated Identity Provider using a randomly generated Id
POST /api/identity-provider
API Key Authentication
Create a SAML v2 IdP Initiated Identity Provider with the provided unique id
POST /api/identity-provider/{identityProviderId}

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

Request Parameters

identityProviderIdUUIDDefaults to secure random UUID

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

Request Body

identityProvider.applicationConfigurationMap<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistrationBooleanDefaults 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].enabledBooleanDefaults to false

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

identityProvider.assertionDecryptionConfiguration.enabledBooleanDefaults to falseAvailable 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.keyTransportDecryptionKeyIdUUIDAvailable 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.debugBooleanDefaults 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.emailClaimString

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.enabledBooleanDefaults to false

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

identityProvider.issuerStringrequired

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.keyIdUUIDrequired

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

identityProvider.lambdaConfiguration.reconcileIdUUID

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.linkingStrategyStringDefaults to LinkByEmailAvailable 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 - 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.nameStringrequired

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

identityProvider.tenantConfigurationMap<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].limitUserLinkCountObjectAvailable since 1.32.0
The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabledBooleanDefaults to falseAvailable since 1.32.0
When enabled, the number of identity provider links a user may create is enforced by maximumLinks .
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinksIntegerDefaults to 42Available 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.typeStringrequired

This field must be set to SAMLv2IdPInitiated.

identityProvider.uniqueIdClaimString

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.useNameIdForEmailBoolean

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.usernameClaimString

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

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",
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "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"
  }
}

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.
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.applicationConfigurationMap<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistrationBoolean

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].enabledBoolean

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

identityProvider.assertionDecryptionConfiguration.enabledBooleanAvailable 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.keyTransportDecryptionKeyIdUUIDAvailable 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.debugBooleanAvailable 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.emailClaimString

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

identityProvider.enabledBoolean

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

identityProvider.idUUID

The Id of the provider.

identityProvider.insertInstantLong

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

identityProvider.issuerString

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

identityProvider.lastUpdateInstantLong

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

identityProvider.keyIdUUID

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

identityProvider.lambdaConfiguration.reconcileId

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

identityProvider.linkingStrategyStringDefaults to LinkByEmailAvailable 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.nameString

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

identityProvider.tenantConfigurationMap<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].limitUserLinkCountObjectAvailable since 1.32.0
The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabledBooleanDefaults to falseAvailable since 1.32.0
When enabled, the number of identity provider links a user may create is enforced by maximumLinks .
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinksIntegerDefaults to 42Available 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.typeString

This field will be SAMLv2IdPInitiated.

identityProvider.uniqueIdClaimString

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.useNameIdForEmailBoolean

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

identityProvider.usernameClaimString

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

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"
  }
}

Retrieve a SAML v2 IdP Initiated Identity Provider

Request

API Key Authentication
Retrieve an Identity Provider by Id
GET /api/identity-provider/{identityProviderId}

Request Parameters

identityProviderIdUUIDrequired

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.

Response Body

identityProvider.applicationConfigurationMap<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistrationBoolean

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].enabledBoolean

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

identityProvider.assertionDecryptionConfiguration.enabledBooleanAvailable 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.keyTransportDecryptionKeyIdUUIDAvailable 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.debugBooleanAvailable 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.emailClaimString

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

identityProvider.enabledBoolean

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

identityProvider.idUUID

The Id of the provider.

identityProvider.insertInstantLong

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

identityProvider.issuerString

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

identityProvider.lastUpdateInstantLong

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

identityProvider.keyIdUUID

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

identityProvider.lambdaConfiguration.reconcileId

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

identityProvider.linkingStrategyStringDefaults to LinkByEmailAvailable 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.nameString

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

identityProvider.tenantConfigurationMap<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].limitUserLinkCountObjectAvailable since 1.32.0
The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabledBooleanDefaults to falseAvailable since 1.32.0
When enabled, the number of identity provider links a user may create is enforced by maximumLinks .
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinksIntegerDefaults to 42Available 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.typeString

This field will be SAMLv2IdPInitiated.

identityProvider.uniqueIdClaimString

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.useNameIdForEmailBoolean

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

identityProvider.usernameClaimString

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

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"
  }
}

Update a SAML v2 IdP Initiated Identity Provider

This API is used to update an existing SAML v2 IdP Initiated Identity Provider.

You must specify all of the properties of the SAML v2 IdP Initiated Identity Provider when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing SAML v2 IdP Initiated Identity Provider and your new data. It replaces the existing SAML v2 IdP Initiated Identity Provider with your new data.

Utilize the PATCH HTTP method to send specific changes to merge into an existing SAML v2 IdP Initiated Identity Provider.

Request

API Key Authentication
Update an Identity Provider
PUT /api/identity-provider/{identityProviderId}
PATCH /api/identity-provider/{identityProviderId}

When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902] or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

When using the PATCH method with a Content-Type of application/json the provided request parameters will be merged into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

Request Parameters

identityProviderIdUUIDrequired

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

Request Body

identityProvider.applicationConfigurationMap<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistrationBooleanDefaults 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].enabledBooleanDefaults to false

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

identityProvider.assertionDecryptionConfiguration.enabledBooleanDefaults to falseAvailable 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.keyTransportDecryptionKeyIdUUIDAvailable 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.debugBooleanDefaults 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.emailClaimString

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.enabledBooleanDefaults to false

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

identityProvider.issuerStringrequired

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.keyIdUUIDrequired

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

identityProvider.lambdaConfiguration.reconcileIdUUID

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.linkingStrategyStringDefaults to LinkByEmailAvailable 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 - 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.nameStringrequired

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

identityProvider.tenantConfigurationMap<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].limitUserLinkCountObjectAvailable since 1.32.0
The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabledBooleanDefaults to falseAvailable since 1.32.0
When enabled, the number of identity provider links a user may create is enforced by maximumLinks .
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinksIntegerDefaults to 42Available 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.typeStringrequired

This field must be set to SAMLv2IdPInitiated.

identityProvider.uniqueIdClaimString

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.useNameIdForEmailBoolean

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.usernameClaimString

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

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",
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "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"
  }
}

Response

The response for this API contains the SAML v2 IdP Initiated Identity Provider that was updated.

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 are trying to update 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.

Response Body

identityProvider.applicationConfigurationMap<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistrationBoolean

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].enabledBoolean

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

identityProvider.assertionDecryptionConfiguration.enabledBooleanAvailable 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.keyTransportDecryptionKeyIdUUIDAvailable 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.debugBooleanAvailable 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.emailClaimString

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

identityProvider.enabledBoolean

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

identityProvider.idUUID

The Id of the provider.

identityProvider.insertInstantLong

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

identityProvider.issuerString

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

identityProvider.lastUpdateInstantLong

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

identityProvider.keyIdUUID

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

identityProvider.lambdaConfiguration.reconcileId

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

identityProvider.linkingStrategyStringDefaults to LinkByEmailAvailable 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.nameString

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

identityProvider.tenantConfigurationMap<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].limitUserLinkCountObjectAvailable since 1.32.0
The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabledBooleanDefaults to falseAvailable since 1.32.0
When enabled, the number of identity provider links a user may create is enforced by maximumLinks .
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinksIntegerDefaults to 42Available 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.typeString

This field will be SAMLv2IdPInitiated.

identityProvider.uniqueIdClaimString

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.useNameIdForEmailBoolean

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

identityProvider.usernameClaimString

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

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"
  }
}

Delete a SAML v2 IdP Initiated Identity Provider

Request

API Key Authentication
Delete a SAML v2 IdP Initiated Identity Provider by Id
DELETE /api/identity-provider/{identityProviderId}

Request Parameters

identityProviderIdUUIDrequired

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

Response

This API does not return a JSON response body.

Response Codes
Code Description
200 The request was successful.
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.

Complete a SAML v2 IdP Initiated Login

This API allows you to complete a SAML v2 login after the user has authenticated with a SAML v2 identity provider.

This API is intended to be used if you want to build your own page to handle the SAML response. Using this API you can pass the SAMLResponse returned from the SAML v2 provider to FusionAuth and we will complete the login workflow and reconcile the user to FusionAuth.

The user does not need to exist yet in FusionAuth to utilize this API, depending on the configured linking strategy. The SAMLResponse returned from the provider will be used to retrieve the user’s information. If that user does not yet exist in FusionAuth the user may be created.

If createRegistration has been enabled for this identity provider and the user does not yet have a registration for this application, a registration will be automatically created for the user.

The user will be assigned any default roles configured for the application. If createRegistration has not been enabled, a registration will not be created if one does not yet exist. This last scenario is useful if you wish to manually provision users and then subsequently allow them to login with this identity provider.

Request

No Authentication Required
Complete SAML v2 IdP Initiated Login
POST /api/identity-provider/login

Request Headers

X-Forwarded-ForString

The IP address of a client requesting authentication. If the IP address is provided it will be stored in the user’s login record. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available. However, the request body value takes precedence.

X-FusionAuth-TenantIdString

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Request Body

applicationIdUUIDrequired
The Id of the Application the user is to be logged into. This application must have SAML v2 IdP Initiated login enabled for this request to succeed.
data.samlResponseStringrequired
The SAMLResponse parameter from the form submit (via a POST request) from the SAML v2 IdP Initiated identity provider.
identityProviderIdUUIDrequired

The unique Id of the identity provider to process this login request.

ipAddressString
The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.
metaData.device.descriptionString
A human readable description of the device represented by the device parameter.
metaData.device.lastAccessedAddressString
The IP address of this login request.
metaData.device.nameString
A human readable name of the device represented by the device parameter.
metaData.device.typeString

The type of device represented by the device parameter.

Prior to version 1.46.0, this value was restricted to the following types:

  • BROWSER
  • DESKTOP
  • LAPTOP
  • MOBILE
  • OTHER
  • SERVER
  • TABLET
  • TV
  • UNKNOWN

In version 1.46.0 and beyond, this value can be any string value you'd like, have fun with it!

noJWTBooleanDefaults to false

When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token field, and the access_token and refresh_token cookies will not be written to the HTTP response.

This optional parameter may be helpful when performing high volume authentication requests and the JWT is not being utilized, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.

noLinkBooleanDefaults to falseAvailable since 1.29.0
When this value is set to true, if a link does not yet exist to a FusionAuth user, a 404 status code will be returned instead of using the requested linking strategy. This may be useful if you want to identify if a link exists before starting a full interactive workflow with the user to complete a link.

Example Request JSON

{
  "applicationId": "10000000-0000-0002-0000-000000000001",
  "data": {
    "samlResponse": "PHNhbWxwOlJlc3BvbnNlIElEPSJfYzgxODM3YWMtNjQ2NS00MWNjLWExMDItNjI1N2Q3MTEyNDczIiBWZXJzaW9uPSIyLjAiIElzc3VlSW5zdGFudD0iMjAxOS0wMi0yOFQxODoyOTo1NS40NzNaIiBEZXN0aW5hdGlvbj0iaHR0cHM6Ly9sb2NhbC5mdXNpb25hdXRoLmlvL29hdXRoMi9jYWxsYmFjayIgSW5SZXNwb25zZVRvPSJpZDMxZjgzYjM1LTU5NTQtNGI2Ny1hY2Y4LTc2M2MxNWZjM2FhYyIgeG1sbnM6c2FtbHA9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpwcm90b2NvbCI+PElzc3VlciB4bWxucz0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOmFzc2VydGlvbiI+aHR0cHM6Ly9zdHMud2luZG93cy5uZXQvYzIxNTAxMTEtM2M0NC00NTA4LTlmMDgtNzkwY2I0MDMyYTIzLzwvSXNzdWVyPjxzYW1scDpTdGF0dXM+PHNhbWxwOlN0YXR1c0NvZGUgVmFsdWU9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpzdGF0dXM6U3VjY2VzcyIvPjwvc2FtbHA6U3RhdHVzPjxBc3NlcnRpb24gSUQ9Il85OThiMTBhNC00YTQ5LTQ2OGEtOWQ3ZC0yZTFiNmRlNTFjMWIiIElzc3VlSW5zdGFudD0iMjAxOS0wMi0yOFQxODoyOTo1NS40NzNaIiBWZXJzaW9uPSIyLjAiIHhtbG5zPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6YXNzZXJ0aW9uIj48SXNzdWVyPmh0dHBzOi8vc3RzLndpbmRvd3MubmV0L2MyMTUwMTExLTNjNDQtNDUwOC05ZjA4LTc5MGNiNDAzMmEyMy88L0lzc3Vlcj48U2lnbmF0dXJlIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5L3htbGRzaWcjIj48U2lnbmVkSW5mbz48Q2Fub25pY2FsaXphdGlvbk1ldGhvZCBBbGdvcml0aG09Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvMTAveG1sLWV4Yy1jMTRuIyIvPjxTaWduYXR1cmVNZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNyc2Etc2hhMjU2Ii8+PFJlZmVyZW5jZSBVUkk9IiNfOTk4YjEwYTQtNGE0OS00NjhhLTlkN2QtMmUxYjZkZTUxYzFiIj48VHJhbnNmb3Jtcz48VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnI2VudmVsb3BlZC1zaWduYXR1cmUiLz48VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8xMC94bWwtZXhjLWMxNG4jIi8+PC9UcmFuc2Zvcm1zPjxEaWdlc3RNZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGVuYyNzaGEyNTYiLz48RGlnZXN0VmFsdWU+ZlF3QlJpcWwxT0NzdkI1NGZNNDFvNkpzYjFxK1IvMXN4Q2Q3cFhNWDRldz08L0RpZ2VzdFZhbHVlPjwvUmVmZXJlbmNlPjwvU2lnbmVkSW5mbz48U2lnbmF0dXJlVmFsdWU+TlN4Rk1PVlpmd1M1a29yZ2ZUVkN1TmZLUkEzVTRvS29pWHo3a0ZKQ3p2UXAzYzVSS2k2eWJyZHdlZHp3WGFKalBmUGw0a2k1TmtxOFZMRVliRVJoa0dCL0VBb095RVR3YWJGQ0tzS1VEcUs0OUZiOHZFaWtRWDlYNEhVR0hncWhXdkplbzM2NDhmSFNIdkMwbU9sRnRRMTlmUjhKaUdGalZmTEoyMG9VMTFFUkNIVnFPWWc5dU9uLzBFcFJVK1hESW5kTkFMUDdqc0VFMXVQdUQ0aUR0dkxucWFLTGtHai9MMUk3OUU4WjA4eTRoLzRidVNiQjNSNXRIUHlaalpBcnBCc1ZzY2tUbldCZVAvR0F4QlZCZ1d6R28rQ0NNSGlONVJxTS95akN4Wm95aHVQbU9ISk9lQS9KcENadTRSM0d6dUUyM1gzblJjN1hLOS9XdFpQLzdRPT08L1NpZ25hdHVyZVZhbHVlPjxLZXlJbmZvPjxYNTA5RGF0YT48WDUwOUNlcnRpZmljYXRlPk1JSUM4RENDQWRpZ0F3SUJBZ0lRUjdodnZzbjRTYkZBRjVNY2ZRNkdiakFOQmdrcWhraUc5dzBCQVFzRkFEQTBNVEl3TUFZRFZRUURFeWxOYVdOeWIzTnZablFnUVhwMWNtVWdSbVZrWlhKaGRHVmtJRk5UVHlCRFpYSjBhV1pwWTJGMFpUQWVGdzB4T1RBeU1qY3lNVFV3TWpSYUZ3MHlNakF5TWpjeU1UVXdNalJhTURReE1qQXdCZ05WQkFNVEtVMXBZM0p2YzI5bWRDQkJlblZ5WlNCR1pXUmxjbUYwWldRZ1UxTlBJRU5sY25ScFptbGpZWFJsTUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF6WUozV3VhdWtVVEFrMDJPL3cyRFBRanVONnFqZC9WSHBWSWE0OGQrd0JDWkxibUJ6NjYxb2J4Skxnc3pRa0ZLMlVJaWVmbjY0TDB4RHIza0dKcCt4dytZRjVSVFVtTzhMVTRqNlovL01XSS9XTjdqZnVwRERJYVUxSlZVbG83My81TVdVUE8yQVY0LzFGL2YvUmhuTWRwYlpUVnFiV0tMT21BYlJmaWMwb3pHOW15Q0xBeFMrNW9rWSsyaW1CSndMSndzU3ROcjAxTmJiT2JhdFFmY0FXV2JFTi9hT1NZbXE1QlFwOXJyV3FmK1pQRFVqWWc0c3VsaUVHWlZwY3lZc1JxeHhvaFdQU2JRd0pZeEV3Wmg3UTFsc2xQdm92QlBxeC9ZRkV2MXUveVUvc3ZVUnVTd0YvUUd4b0xyS3E4OXVMT2c1V1hsU203dkRXUHB2S0MyaFFJREFRQUJNQTBHQ1NxR1NJYjNEUUVCQ3dVQUE0SUJBUUJPaUVod0ZZNjR6R3ZWZW56eWkzR0k3djlFK0tDeXFFL0pkZGdxSGhsd0lQQzAwTXRRK3pEbE8ralZIWmw5ZWhJQzVLY1E1VktsQnh4S1VGM0lJdzFRY0o4UGVQenlzYmtYMXNmUzYyUmJmczVjWlcyQUlRL3dtY1B2V3MwenhjcmVPbzBRaGdUcmdnYlNlYjFpcUZEWTdFTkk0Uk0rdkZWWTVINDROZEVha05ucHowVm1kUkp6M1Q4R0Q0cThqRCtjOWUwZWZNTHhzQmxkSy8reHY2QnJNN3pKcUdCdy8yajlkRThPWXZ0Ym9xRm5PSmgrWkptcEd3ZC9EWlc0aHpKZDMzVDVWYVJjYklhRTl4ZUNTeEthY1ljWUpwU0RrVlVQdTBXSXJlU0FLKzZzbTM0MWZINDk5NEhiczhLUGF5MjQ5bEZLL0FFODZDNERBa00zeHd4MTwvWDUwOUNlcnRpZmljYXRlPjwvWDUwOURhdGE+PC9LZXlJbmZvPjwvU2lnbmF0dXJlPjxTdWJqZWN0PjxOYW1lSUQgRm9ybWF0PSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoxLjE6bmFtZWlkLWZvcm1hdDplbWFpbEFkZHJlc3MiPmJyaWFuX2ludmVyc29mdC5jb20jRVhUI0BicmlhbmludmVyc29mdC5vbm1pY3Jvc29mdC5jb208L05hbWVJRD48U3ViamVjdENvbmZpcm1hdGlvbiBNZXRob2Q9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDpjbTpiZWFyZXIiPjxTdWJqZWN0Q29uZmlybWF0aW9uRGF0YSBJblJlc3BvbnNlVG89ImlkMzFmODNiMzUtNTk1NC00YjY3LWFjZjgtNzYzYzE1ZmMzYWFjIiBOb3RPbk9yQWZ0ZXI9IjIwMTktMDItMjhUMTg6MzQ6NTUuNDczWiIgUmVjaXBpZW50PSJodHRwczovL2xvY2FsLmZ1c2lvbmF1dGguaW8vb2F1dGgyL2NhbGxiYWNrIi8+PC9TdWJqZWN0Q29uZmlybWF0aW9uPjwvU3ViamVjdD48Q29uZGl0aW9ucyBOb3RCZWZvcmU9IjIwMTktMDItMjhUMTg6MjQ6NTUuNDczWiIgTm90T25PckFmdGVyPSIyMDE5LTAyLTI4VDE5OjI0OjU1LjQ3M1oiPjxBdWRpZW5jZVJlc3RyaWN0aW9uPjxBdWRpZW5jZT5odHRwczovL2xvY2FsLmZ1c2lvbmF1dGguaW88L0F1ZGllbmNlPjwvQXVkaWVuY2VSZXN0cmljdGlvbj48L0NvbmRpdGlvbnM+PEF0dHJpYnV0ZVN0YXRlbWVudD48QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vaWRlbnRpdHkvY2xhaW1zL3RlbmFudGlkIj48QXR0cmlidXRlVmFsdWU+YzIxNTAxMTEtM2M0NC00NTA4LTlmMDgtNzkwY2I0MDMyYTIzPC9BdHRyaWJ1dGVWYWx1ZT48L0F0dHJpYnV0ZT48QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vaWRlbnRpdHkvY2xhaW1zL29iamVjdGlkZW50aWZpZXIiPjxBdHRyaWJ1dGVWYWx1ZT4yYjIwNmJhYS0yMGQyLTQyNzMtYjIyMy00Y2M1MzI4MjcyZTg8L0F0dHJpYnV0ZVZhbHVlPjwvQXR0cmlidXRlPjxBdHRyaWJ1dGUgTmFtZT0iaHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS9pZGVudGl0eS9jbGFpbXMvZGlzcGxheW5hbWUiPjxBdHRyaWJ1dGVWYWx1ZT5CcmlhbiBQb250YXJlbGxpPC9BdHRyaWJ1dGVWYWx1ZT48L0F0dHJpYnV0ZT48QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vaWRlbnRpdHkvY2xhaW1zL2lkZW50aXR5cHJvdmlkZXIiPjxBdHRyaWJ1dGVWYWx1ZT5saXZlLmNvbTwvQXR0cmlidXRlVmFsdWU+PC9BdHRyaWJ1dGU+PEF0dHJpYnV0ZSBOYW1lPSJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL2NsYWltcy9hdXRobm1ldGhvZHNyZWZlcmVuY2VzIj48QXR0cmlidXRlVmFsdWU+aHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2F1dGhlbnRpY2F0aW9ubWV0aG9kL3Bhc3N3b3JkPC9BdHRyaWJ1dGVWYWx1ZT48QXR0cmlidXRlVmFsdWU+aHR0cDovL3NjaGVtYXMubWljcm9zb2Z0LmNvbS93cy8yMDA4LzA2L2lkZW50aXR5L2F1dGhlbnRpY2F0aW9ubWV0aG9kL3Vuc3BlY2lmaWVkPC9BdHRyaWJ1dGVWYWx1ZT48L0F0dHJpYnV0ZT48QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2dpdmVubmFtZSI+PEF0dHJpYnV0ZVZhbHVlPkJyaWFuPC9BdHRyaWJ1dGVWYWx1ZT48L0F0dHJpYnV0ZT48QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL3N1cm5hbWUiPjxBdHRyaWJ1dGVWYWx1ZT5Qb250YXJlbGxpPC9BdHRyaWJ1dGVWYWx1ZT48L0F0dHJpYnV0ZT48QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL2VtYWlsYWRkcmVzcyI+PEF0dHJpYnV0ZVZhbHVlPmJyaWFuQGludmVyc29mdC5jb208L0F0dHJpYnV0ZVZhbHVlPjwvQXR0cmlidXRlPjxBdHRyaWJ1dGUgTmFtZT0iaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI+PEF0dHJpYnV0ZVZhbHVlPmJyaWFuX2ludmVyc29mdC5jb20jRVhUI0BicmlhbmludmVyc29mdC5vbm1pY3Jvc29mdC5jb208L0F0dHJpYnV0ZVZhbHVlPjwvQXR0cmlidXRlPjwvQXR0cmlidXRlU3RhdGVtZW50PjxBdXRoblN0YXRlbWVudCBBdXRobkluc3RhbnQ9IjIwMTktMDItMjdUMjE6Mzk6NDguNzI2WiIgU2Vzc2lvbkluZGV4PSJfOTk4YjEwYTQtNGE0OS00NjhhLTlkN2QtMmUxYjZkZTUxYzFiIj48QXV0aG5Db250ZXh0PjxBdXRobkNvbnRleHRDbGFzc1JlZj51cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6YWM6Y2xhc3NlczpQYXNzd29yZDwvQXV0aG5Db250ZXh0Q2xhc3NSZWY+PC9BdXRobkNvbnRleHQ+PC9BdXRoblN0YXRlbWVudD48L0Fzc2VydGlvbj48L3NhbWxwOlJlc3BvbnNlPg=="
  },
  "identityProviderId": "19544aa2-d634-4859-b193-e57af82b5d12",
  "ipAddress": "192.168.1.42"
}

Response

The response for this API contains the User object.

Response Codes

CodeDescription
200The authentication was successful. The response will contain the User object that was authenticated.
202The user was authenticated successfully. The user is not registered for the application specified by applicationId on the request.
The response will contain the User object that was authenticated.
203The user was authenticated successfully. The user is required to change their password, the response will contain the changePasswordId to be used on the Change Password API.

Example Response JSON

{
  "changePasswordId": "XOgai4Ro68xfGiex0ngXiJ2bbhduM4Pm7h3lvF0xibQ",
  "changePasswordReason": "Expired"
}

204The login is pending action by the end user. Wait and try the request again.
212The user’s email address has not yet been verified. The response will contain the User object that was authenticated. If the verification strategy has been set to FormField, the response will contain the emailVerificationId that was generated for the user.
213The user’s registration has not yet been verified. The response will contain the User object that was authenticated. If the verification strategy has been set to FormField, the response will contain the registrationVerificationId that was generated for the user.
Prior to version 1.27.0, this status code was not returned, and you will see a 200 instead.
232The user is completing a login with an Identity Provider configured to use the Create a pending link linking strategy and this user does not have a link established. The API response will only contain the pendingIdPLinkId and, possibly, threatsDetected. A call to the Link API’s Complete a Pending Link endpoint is required. Once the user is linked, calling this API again will allow login to succeed.

Example Response JSON

{
  "pendingIdPLinkId": "0TxfELqDE0d2Y6PqCkztz4o-lXdRyAscAXh8EAyRZsx"
}
242The user was authenticated successfully. The user has two factor authentication enabled. Since version 1.42.0, this status code is also returned when two factor authentication is required. The response will contain the twoFactorId to be used on the Complete Two Factor Authentication.

Example Response JSON

{
  "methods": [
    {
      "authenticator": {
        "algorithm": "HmacSHA1",
        "codeLength": 6,
        "timeStep": 30
      },
      "id": "2KSZ",
      "method": "authenticator"
    },
    {
      "email": "richard@fusionauth.io",
      "id": "KLRT",
      "method": "email"
    }
  ],
  "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
}
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.
401Unable to complete the login request. The user cannot be reconciled or logged in using the external identity provider.
404The user was not found, the password was incorrect, the linking strategy is set to disabled, or the value noLink: true is passed on the linking request. The response will be empty.
409The user is currently in an action that has prevented login. The response will contain the actions that prevented login.

Example Response JSON

{
  "actions": [
    {
      "actionId": "00000000-0000-0000-0000-000000000042",
      "actionerUserId": "00000000-0000-0001-0000-000000000000",
      "expiry": 1571786483322,
      "localizedName": "Prevent Login Action",
      "localizedReason": "Hard Lock",
      "name": "Prevent Login Action",
      "reason": "Hard Lock",
      "reasonCode": "hard_lock"
    }
  ]
}
410The user has expired. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.
504One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

Response Body

emailVerificationIdString

An email verification Id, which is needed when performing your own email verification using the /api/user/verify-email API.

This field is only returned when the tenant.emailConfiguration.verificationStrategy is set to FormField.

identityVerificationIdStringAvailable since 1.59.0

An identity verification Id, which is needed when performing your own identity verification using the /api/identity/verify API.

This field is only returned under the following conditions, based on the identity that was used to log in:

  • An email address - the tenant.emailConfiguration.verificationStrategy is set to FormField.
  • A phone number - the tenant.phoneConfiguration.verificationStrategy is set to FormField.
pendingIdPLinkIdStringAvailable since 1.28.0

The pending identity provider link Id. This value is created when logging in with an identity provider configured with a linking strategy of Create a pending link. It will only be included in the response body when this strategy is configured and a link does not yet exist for the user. It is used in conjunction with the Link APIs to complete a pending link.

refreshTokenString

The refresh token that can be used to obtain a new access token once the provided one has expired.

Because a refresh token is per user and per application, this value will only be returned when an applicationId was provided on the login request and the user is registered to the application.

You must explicitly allow generation of refresh tokens when using the Login API.

Configure the application.loginConfiguration.generateRefreshTokens setting via the API or enable the setting by navigating to the Application -> My Application -> Security tab.

refreshTokenIdStringAvailable since 1.37.0

When the refreshToken is returned in the response, this field will also be returned. This unique Id is the persistent identifier for this refresh token, and will not change even when using one-time use refresh tokens. This value may optionally be used to revoke the token using the Refresh Token API.

stateObject

If authenticated using a One Time Password and state was provided during the Change Password request this value will be returned exactly as it was provided.

tokenStringAvailable since 1.16.0

The access token, this string is an encoded JSON Web Token (JWT).

When the user will be sent a setup password email or sms message, this token will not be returned.

tokenExpirationInstantLongAvailable since 1.33.0

The instant the token will expire. If the response does not contain a token , this field will also be omitted from the response.

user.activeBoolean

True if the User is active. False if the User has been deactivated. Deactivated Users will not be able to log in.

user.birthDateString

The User’s birthdate formatted as YYYY-MM-DD

user.breachedPasswordLastCheckedInstantLong

The instant this user’s password was last checked to determine if it is compromised.

user.connectorIdUUIDAvailable since 1.18.0

The unique Id of the Connector associated with the System of Record being used to authenticate the user.

user.cleanSpeakIdUUID

This Id is used by FusionAuth when the User’s username is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

user.dataObject

An object that can hold any information about the User that should be persisted.

user.data.emailString

This field will be used as the email address if no user.email field is found.

This feature was removed in version 1.26.0 and added back in 1.27.2.

user.emailString

The User’s email address.

user.expiryLong

The expiration instant of the User’s account. An expired user is not permitted to log in.

user.firstNameString

The first name of the User.

user.fullNameString

The User’s full name as a separate field that is not calculated from firstName and lastName .

user.idUUID

The User’s unique Id.

user.identitiesArrayAvailable since 1.59.0

The list of identities that exist for a User.

user.identities[x].displayValueStringAvailable since 1.59.0

The display value for the identity. Only used for username type identities. If the unique username feature is not enabled, this value will be the same as user.identities[x].value . Otherwise, it will be the username the User has chosen. For primary username identities, this will be the same value as user.username .

user.identities[x].insertInstantLongAvailable since 1.59.0

The instant when the identity was created.

user.identities[x].lastLoginInstantLongAvailable since 1.59.0

The instant when the identity was last used to log in. If a User has multiple identity types (username, email, and phoneNumber), then this value will represent the specific identity they last used to log in. This contrasts with user.lastLoginInstant , which represents the last time any of the User’s identities was used to log in.

Identity provider logins will not be reflected here (see user.lastLoginInstant for a field that includes identity provider logins).

user.identities[x].lastUpdateInstantLongAvailable since 1.59.0

The instant when the identity was last updated.

user.identities[x].moderationStatusStringAvailable since 1.59.0

The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

  • ACTIVE - the username is active
  • PENDING - the username is pending approval/moderation
  • REJECTED - the username was rejected during moderation

If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

Only used for username type identities. For primary username identities, this will be the same value as user.usernameStatus .

user.identities[x].typeStringAvailable since 1.59.0

The identity type. The possible values are:

  • email - identities defined by an email address
  • phoneNumber - identities defined by a phone number
  • username - identities defined by a username
user.identities[x].valueStringAvailable since 1.59.0

The value represented by the identity. The contents of this field depend on user.identities[x].type and will be one of the following:

  • Email address - The User’s email address, always lower cased. For primary email identities, this will be the same value as user.email
  • Phone number - The User’s phone number, in E.164 canonical format. For primary phone number identities, this will be the same value as user.phoneNumber
  • Username - User’s username - this will be the same as user.identities[x].displayValue . For primary username identities, this will be the same value as user.username

This value is unique within a tenant for a particular user.identities[x].type .

If the unique usernames feature is enabled, value will be the unique username (within the tenant). For primary username identities, this will also be the same value as user.uniqueUsername .

user.identities[x].verifiedBooleanAvailable since 1.59.0

Whether verification was actually performed on the identity by FusionAuth. This is used in combination with the user.identities[x].verifiedReason to decide whether an identity needs verification.

user.identities[x].verifiedInstantLongAvailable since 1.59.0

The instant when verification was performed on the identity. This field is only populated when verification was actually performed on the identity by FusionAuth.

user.identities[x].verifiedReasonStringAvailable since 1.59.0

The reason the User’s identity was verified or not verified. The possible values are:

  • Skipped - Verification was skipped due to the skipVerification parameter on the request
  • Trusted - Identity was created via an identity provider or a connector
  • Unverifiable - FusionAuth doesn’t know how to verify this identity type. Usernames are an example
  • Implicit - Verification was implicitly performed by sending a set password or passwordless message
  • Pending - Tenant policy requires verification but no verification has been performed yet
  • Completed - Verification was performed by FusionAuth
  • Disabled - Tenant policy did not require verification
  • Import - User was imported so verification was not performed by FusionAuth

If this field is Disabled, Import, Skipped, Trusted, or Unverifiable, then verification will not be required, regardless of the user.identities[x].verified value. For Implicit, Pending, or Completed, the identity will require verification if user.identities[x].verified is false.

user.imageUrlString

The URL that points to an image file that is the User’s profile image.

user.insertInstantLong

The instant when the user was created.

user.lastLoginInstantLong

The instant when the User logged in last. See user.identities[x].lastLoginInstant for more granular information based on identity.

user.lastNameString

The User’s last name.

user.lastUpdateInstantLong

The instant when the User was last updated.

user.membershipsArray

The list of memberships for the User.

user.memberships[x].dataObject

An object that can hold any information about the User for this membership that should be persisted.

user.memberships[x].groupIdUUID

The Id of the Group of this membership.

user.memberships[x].idUUID

The unique Id of this membership.

user.memberships[x].insertInstantLong

The instant that the membership was created.

user.middleNameString

The User’s middle name.

user.mobilePhoneString

The User’s mobile phone number. This is useful if you will be sending push notifications or SMS messages to the User.

This differs from user.phoneNumber and cannot be used to log in.

user.parentEmailStringAvailable since 1.7.0

The email address of the user’s parent or guardian. If this value was provided during a create or update operation, this value will only remain until the child is claimed by a parent.

user.passwordChangeRequiredBoolean

Indicates that the User’s password needs to be changed during their next login attempt.

user.passwordLastUpdateInstantLong

The instant that the User last changed their password.

user.phoneNumberStringAvailable since 1.59.0

The User’s primary phone number. The phone number is stored and returned in E.164 canonical format, however a phone number is considered unique regardless of the format. 303-555-1212 is considered equal to +13035551212 so either version of this phone number can be used whenever providing it as input to an API.

This differs from user.mobilePhone in that user.phoneNumber can be used to log in, just like an email address or a username.

user.preferredLanguagesArray<String>

An array of locale strings that give, in order, the User’s preferred languages. These are important for email templates and other localizable text. See Locales.

user.registrationsArray

The list of registrations for the User. This will include registrations for inactive applications.

user.registrations[x].applicationIdUUID

The Id of the Application that this registration is for.

user.registrations[x].authenticationTokenString

The Authentication Token for this registration (if one exists).

user.registrations[x].cleanSpeakIdUUID

This Id is used by FusionAuth when the User’s username for this registration is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the content Id of the username inside CleanSpeak.

user.registrations[x].dataObject

An object that can hold any information about the User for this registration that should be persisted.

user.registrations[x].idUUID

The Id of this registration.

user.registrations[x].insertInstantLong

The instant that this registration was created.

user.registrations[x].lastLoginInstantLong

The instant that the User last logged into the Application for this registration.

user.registrations[x].preferredLanguagesArray<String>

An array of locale strings that give, in order, the User’s preferred languages for this registration. These are important for email templates and other localizable text.

user.registrations[x].rolesArray<String>

The list of roles that the User has for this registration. The string is the role’s Name not the role’s Id, e.g. admin or user-role.

user.registrations[x].timezoneString

The User’s preferred timezone for this registration. The string will be in an IANA time zone format.

user.registrations[x].tokensMap<String,StringDEPRECATED

A map that contains tokens returned from identity providers.

For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name Facebook. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id.

Removed in 1.28.0

The token returned and stored from the Identity Provider is now stored in the IdP link and is retrievable using the Identity Provider Link API.

user.registrations[x].usernameString

The username of the User for this registration only. This is for display purposes and cannot be used to log in.

user.registrations[x].usernameStatusString

The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

  • ACTIVE - the username is active
  • PENDING - the username is pending approval/moderation
  • REJECTED - the username was rejected during moderation

If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

user.registrations[x].verifiedBoolean

This value indicates if this User’s registration has been verified.

For additional information, see these tutorials:

user.registrations[x].verifiedInstantLongAvailable since 1.48.0

The instant that this registration was verified.

user.tenantIdUUID

The Id of the Tenant that this User belongs to.

user.timezoneString

The User’s preferred timezone. This can be used as a default to display instants, and it is recommended that you allow Users to change this per-session. The string will be in an IANA time zone format.

user.twoFactor.methods[x].authenticator.algorithmString

The algorithm used by the TOTP authenticator. With the current implementation, this will always be HmacSHA1.

user.twoFactor.methods[x].authenticator.codeLengthInteger

The length of code generated by the TOTP. With the current implementation, this will always be 6.

user.twoFactor.methods[x].authenticator.timeStepInteger

The time-step size in seconds. With the current implementation, this will always be 30.

user.twoFactor.methods[x].emailString

The value of the email address for this method. Only present if user.twoFactor.methods[x].method is email.

user.twoFactor.methods[x].idString

The unique Id of the method.

user.twoFactor.methods[x].lastUsedBoolean

true if this method was used most recently.

user.twoFactor.methods[x].methodString

The type of this method. There will also be an object with the same value containing additional information about this method. The possible values are:

  • authenticator
  • email
  • sms
user.twoFactor.methods[x].mobilePhoneString

The value of the mobile phone for this method. Only present if user.twoFactor.methods[x].method is sms.

user.twoFactorDeliveryStringDEPRECATED

The User’s preferred delivery for verification codes during a two factor login request.

The possible values are:

  • None
  • TextMessage
Removed in 1.26.0
user.twoFactorEnabledBooleanDEPRECATED

Determines if the User has two factor authentication enabled for their account or not.

Removed in 1.26.0
user.usernameString

The username of the User.

user.usernameStatusString

The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are:

  • ACTIVE - the username is active
  • PENDING - the username is pending approval/moderation
  • REJECTED - the username was rejected during moderation

If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again.

user.verifiedBooleanDEPRECATED

Whether or not the User’s primary email identity has been verified. This does NOT indicate whether phone number identity types are verified.

For additional information, see these tutorials:

Deprecated since 1.59.0

See user.identities[x].verified and user.identities[x].verifiedReason .

user.verifiedInstantLongAvailable since 1.48.0

The first instant that the User’s primary email address or phone number was verified. This value is immutable and cannot change for a user once set.

Example Response JSON

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo",
  "user": {
    "active": true,
    "birthDate": "1976-05-30",
    "connectorId": "e3306678-a53a-4964-9040-1c96f36dda72",
    "data": {
      "displayName": "Johnny Boy",
      "favoriteColors": [
        "Red",
        "Blue"
      ]
    },
    "email": "example@fusionauth.io",
    "expiry": 1571786483322,
    "firstName": "John",
    "fullName": "John Doe",
    "id": "00000000-0000-0001-0000-000000000000",
    "identities": [
      {
        "insertInstant": 1742936980069,
        "lastLoginInstant": 1742936980069,
        "lastUpdateInstant": 1742936980069,
        "primary": true,
        "type": "email",
        "value": "example@fusionauth.io",
        "verified": false,
        "verifiedReason": "Disabled"
      },
      {
        "insertInstant": 1742936980069,
        "lastLoginInstant": 1742936980069,
        "lastUpdateInstant": 1742936980069,
        "primary": true,
        "type": "phoneNumber",
        "value": "+13035551212",
        "verified": false,
        "verifiedReason": "Disabled"
      },
      {
        "displayValue": "johnny123",
        "insertInstant": 1742936980069,
        "lastLoginInstant": 1742936980069,
        "lastUpdateInstant": 1742936980069,
        "moderationStatus": "ACTIVE",
        "primary": true,
        "type": "username",
        "value": "johnny123",
        "verified": false,
        "verifiedReason": "Unverifiable"
      }
    ],
    "imageUrl": "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
    "insertInstant": 1742936980069,
    "lastLoginInstant": 1742936980069,
    "lastName": "Doe",
    "middleName": "William",
    "mobilePhone": "303-555-1234",
    "passwordChangeRequired": false,
    "passwordLastUpdateInstant": 1742936980069,
    "phoneNumber": "+13035551212",
    "preferredLanguages": [
      "en",
      "fr"
    ],
    "registrations": [
      {
        "applicationId": "10000000-0000-0002-0000-000000000001",
        "data": {
          "displayName": "Johnny",
          "favoriteSports": [
            "Football",
            "Basketball"
          ]
        },
        "id": "00000000-0000-0002-0000-000000000000",
        "insertInstant": 1742936980069,
        "lastLoginInstant": 1742936980069,
        "preferredLanguages": [
          "en",
          "fr"
        ],
        "roles": [
          "user",
          "community_helper"
        ],
        "username": "johnny123",
        "usernameStatus": "ACTIVE",
        "verified": true,
        "verifiedInstant": 1742936980069
      }
    ],
    "timezone": "America/Denver",
    "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
    "twoFactor": {
      "methods": [
        {
          "authenticator": {
            "algorithm": "HmacSHA1",
            "codeLength": 6,
            "timeStep": 30
          },
          "id": "35VW",
          "method": "authenticator"
        },
        {
          "id": "V7SH",
          "method": "sms",
          "mobilePhone": "555-555-5555"
        },
        {
          "email": "example@fusionauth.io",
          "id": "7K2G",
          "method": "email"
        }
      ]
    },
    "usernameStatus": "ACTIVE",
    "username": "johnny123",
    "verified": true,
    "verifiedInstant": 1742936980069
  }
}

Response Cookies

access_tokenString

The access token, this string is an encoded JSON Web Token (JWT). This cookie is written in the response as an HTTP Only session cookie.

refresh_tokenString

The refresh token. This cookie is written in the response as an HTTP only persistent cookie. The cookie expiration is configured in the JWT configuration for the application or the global JWT configuration.