SAML v2 Identity Provider APIs

Overview

This API has been available since 1.6.0

SAML v2 identity providers connect to external SAML v2 login systems. This type of login will optionally provide a Login with …​ button on FusionAuth’s login page. This button is customizable by using different properties of the identity provider.

Optionally, this identity provider can define one or more domains it is associated with. This is useful for allowing employees to log in with their corporate credentials. As long as the company has an identity solution that provides SAML v2, you can leverage this feature. This is referred to as a Domain Based Identity Provider. If you enable domains for an identity provider, the Login with …​ button will not be displayed. Instead, only the email form field will be displayed initially on the FusionAuth login page. Once the user types in their email address, FusionAuth will determine if the user is logging in locally or if they should be redirected to this identity provider. This is determined by extracting the domain from their email address and comparing it to the domains associated with the identity provider.

FusionAuth will locate the user’s email address in the SAML assertion which will be used to create or lookup the existing user. Additional claims from the SAML response can be used to reconcile the User to FusionAuth by using a SAML v2 Reconcile Lambda. Unless you assign a reconcile lambda to this provider, on the email address will be used from the available assertions returned by the SAML v2 identity provider.

Operations

Login Operations

Integration Details

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

They are autogenerated and viewable within the UI after creating the Identity Provider. Settings → Identity Providers → SAMLv2 → View

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

Issuer: <base_url>/samlv2/sp/{identityProvider.id}

Metadata URL: <base_url>/samlv2/sp/metadata/{identityProvider.id}

Create a SAML v2 Identity Provider

Request

Create a SAML v2 Identity Provider using a generated id

URI

POST /api/identity-provider

Create a SAML v2 Identity Provider with the provided unique id

URI

POST /api/identity-provider/{identityProviderId}

The type property in the request JSON is used to determine that you are managing an SAML v2 identity provider.

Request Parameters

identityProviderId [UUID] Optional defaults 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.applicationConfiguration [Map<UUID, Object>] Optional

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

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String] Optional

This is an optional Application specific override for the top level buttonImageURL.

identityProvider.applicationConfiguration[applicationId].buttonText [String] Optional

This is an optional Application specific override for the top level buttonText.

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.buttonImageURL [String] Optional

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String] Required

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.debug [Boolean] Optional defaults to false 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.

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.domains [Array<String>] Optional

This is an optional list of domains that this SAML v2 provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an identity provider should be used. If an identity provider should be used, the browser is redirected to the login URL of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

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. If this is not set, the useNameIdForEmail flag must be true.

identityProvider.enabled [Boolean] Optional defaults to false

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

identityProvider.idpEndpoint [String] Optional

The SAML v2 login page of the identity provider.

identityProvider.keyId [UUID] Required

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 [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.name [String] Required

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

identityProvider.useNameIdForEmail [Boolean] Optional Defaults to false

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

identityProvider.type [String] Required

This field must be set to SAMLv2.

Example SAML v2 Request JSON
{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "buttonText": "Login with SAML (app text)",
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with SAML",
    "debug": false,
    "emailClaim": "email",
    "enabled": true,
    "idpEndpoint": "https://www.example.com/login",
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "lambdaConfiguration" : {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "name": "My SAML provider",
    "type": "SAMLv2",
    "useNameIdForEmail": true
  }
}

Response

Table 1. 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.

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.applicationConfiguration [Map<UUID, Object>]

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

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String]

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean]

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]

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

identityProvider.buttonImageURL [String]

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

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.domains [Array<String>]

This is an optional list of domains that this SAML v2 provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an identity provider should be used. If an identity provider should be used, the browser is redirected to the login URL of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

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. If this is not set, the useNameIdForEmail flag must be true.

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.idpEndpoint [String]

The SAML v2 login page of the identity provider.

identityProvider.insertInstant [Long]

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

identityProvider.lastUpdateInstant [Long]

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

identityProvider.keyId [UUID]

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.name [String]

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

identityProvider.useNameIdForEmail [Boolean]

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

identityProvider.type [String]

The type of this provider, this field will always be set to SAMLv2.

Example SAML v2 Response JSON
{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "buttonText": "Login with SAML (app text)",
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with SAML",
    "emailClaim": "email",
    "debug" : false,
    "enabled": true,
    "id": "e13afb7b-77c7-4451-9c07-897d38f4fb3d",
    "idpEndpoint": "https://www.example.com/login",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "lambdaConfiguration" : {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "name": "My SAML provider",
    "type": "SAMLv2",
    "useNameIdForEmail": true
  }
}

Retrieve a SAML v2 Identity Provider

Request

Retrieve an Identity Provider by Id

URI

GET /api/identity-provider/{identityProviderId}

Request Parameters

identityProviderId [UUID] Required

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

Response

Table 2. 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.

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.applicationConfiguration [Map<UUID, Object>]

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

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String]

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean]

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]

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

identityProvider.buttonImageURL [String]

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

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.domains [Array<String>]

This is an optional list of domains that this SAML v2 provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an identity provider should be used. If an identity provider should be used, the browser is redirected to the login URL of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

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. If this is not set, the useNameIdForEmail flag must be true.

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.idpEndpoint [String]

The SAML v2 login page of the identity provider.

identityProvider.insertInstant [Long]

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

identityProvider.lastUpdateInstant [Long]

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

identityProvider.keyId [UUID]

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.name [String]

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

identityProvider.useNameIdForEmail [Boolean]

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

identityProvider.type [String]

The type of this provider, this field will always be set to SAMLv2.

Example SAML v2 Response JSON
{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "buttonText": "Login with SAML (app text)",
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with SAML",
    "emailClaim": "email",
    "debug" : false,
    "enabled": true,
    "id": "e13afb7b-77c7-4451-9c07-897d38f4fb3d",
    "idpEndpoint": "https://www.example.com/login",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "lambdaConfiguration" : {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "name": "My SAML provider",
    "type": "SAMLv2",
    "useNameIdForEmail": true
  }
}

Update a SAML v2 Identity Provider

Request

Update an Identity Provider

URI

PUT /api/identity-provider/{identityProviderId}

PATCH /api/identity-provider/{identityProviderId}

Available since 1.12.0

When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters 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

identityProviderId [UUID] Required

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

Request Body

identityProvider.applicationConfiguration [Map<UUID, Object>] Optional

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

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String] Optional

This is an optional Application specific override for the top level buttonImageURL.

identityProvider.applicationConfiguration[applicationId].buttonText [String] Optional

This is an optional Application specific override for the top level buttonText.

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.buttonImageURL [String] Optional

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String] Required

The top-level button text to use on the FusionAuth login page for this Identity Provider.

identityProvider.debug [Boolean] Optional defaults to false 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.

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.domains [Array<String>] Optional

This is an optional list of domains that this SAML v2 provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an identity provider should be used. If an identity provider should be used, the browser is redirected to the login URL of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

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. If this is not set, the useNameIdForEmail flag must be true.

identityProvider.enabled [Boolean] Optional defaults to false

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

identityProvider.idpEndpoint [String] Optional

The SAML v2 login page of the identity provider.

identityProvider.keyId [UUID] Required

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 [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.name [String] Required

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

identityProvider.useNameIdForEmail [Boolean] Optional Defaults to false

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

identityProvider.type [String] Required

This field must be set to SAMLv2.

Example SAML v2 Request JSON
{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "buttonText": "Login with SAML (app text)",
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with SAML",
    "debug": false,
    "emailClaim": "email",
    "enabled": true,
    "idpEndpoint": "https://www.example.com/login",
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "lambdaConfiguration" : {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "name": "My SAML provider",
    "type": "SAMLv2",
    "useNameIdForEmail": true
  }
}

Response

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

Table 3. 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.

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 updated 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.applicationConfiguration [Map<UUID, Object>]

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

identityProvider.applicationConfiguration[applicationId].buttonImageURL [String]

This is an optional Application specific override for the top level button image URL.

identityProvider.applicationConfiguration[applicationId].buttonText [String]

This is an optional Application specific override for the top level button text.

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean]

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]

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

identityProvider.buttonImageURL [String]

The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.

identityProvider.buttonText [String]

The top-level button text to use on the FusionAuth login page for this Identity Provider.

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.domains [Array<String>]

This is an optional list of domains that this SAML v2 provider should be used for. This converts the FusionAuth login form to a domain-based login form. This type of form first asks the user for their email. FusionAuth then uses their email to determine if an identity provider should be used. If an identity provider should be used, the browser is redirected to the login URL of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.

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. If this is not set, the useNameIdForEmail flag must be true.

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.idpEndpoint [String]

The SAML v2 login page of the identity provider.

identityProvider.insertInstant [Long]

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

identityProvider.lastUpdateInstant [Long]

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

identityProvider.keyId [UUID]

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.name [String]

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

identityProvider.useNameIdForEmail [Boolean]

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

identityProvider.type [String]

The type of this provider, this field will always be set to SAMLv2.

Example SAML v2 Response JSON
{
  "identityProvider": {
    "applicationConfiguration": {
      "2c73b816-f48c-4c36-964b-40589a9ae629": {
        "buttonText": "Login with SAML (app text)",
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with SAML",
    "emailClaim": "email",
    "debug" : false,
    "enabled": true,
    "id": "e13afb7b-77c7-4451-9c07-897d38f4fb3d",
    "idpEndpoint": "https://www.example.com/login",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "keyId": "a60f46c9-5d8e-48af-ac23-dbaa00579c57",
    "lambdaConfiguration" : {
      "reconcileId": "0bf07e2d-08fa-4d56-8f63-9f9d40ee7fd5"
    },
    "name": "My SAML provider",
    "type": "SAMLv2",
    "useNameIdForEmail": true
  }
}

Delete a SAML v2 Identity Provider

Request

Delete a SAML v2 Identity Provider by Id

URI

DELETE /api/identity-provider/{identityProviderId}

Request Parameters

identityProviderId [UUID] Required

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

Response

This API does not return a JSON response body.

Table 4. Response Codes
Code Description

200

The request was successful. The response will be empty.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

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

Start a SAML v2 Login Request

This API has been available since 1.19.0

This API is used to initiate a SAML v2 login request when integrating without the FusionAuth hosted login pages.

The SAML v2 AuthN request will require a unique request identifier. This API must be used to record this identifier prior to sending the SAML response from the IdP to FusionAuth in order to protect against SAML response replay attacks. You may optionally provide an identifier to this API if you need to generate your own identifier, or use the generated value provided in the API response.

Request

Start a login request

URI

POST /api/identity-provider/start

Request Body

applicationId [UUID] Required

The Id of the Application the user is to be logged into. This application must have SAML v2 login enabled for this request to succeed.

data.requestId [String] Optional

The optional SAML v2 request identifier to be used when making the SAML AuthN request to the SAML v2 IdP. If this parameter is omitted a value will be generated.

identityProviderId [UUID] Required

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

Example Request JSON
{
  "applicationId": "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
  "identityProviderId": "778985b7-6fd8-414d-acf2-94f18fb7c7e0"
}

Response

The response for this API contains a code that can be used to complete the login request.

Table 5. Response Codes
Code Description

202

The request completed successfully. The response will contain the code to be used to complete the login request.

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

Unable to complete the login request. The response may contain a JSON body describing the reason for the status code in some cases.

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

code [String]

The code used to complete login using the Complete HYPR Login API.

Example Response JSON
{
  "code": "id62bb157cb5a84abe858e0877a39bccda"
}

Complete a SAML v2 Login

This API allows you to complete a SAML v2 login after the user has authenticated with a SAML v2 identity provider. If you are using the FusionAuth login UI with the SAML v2 button you will not utilize this API directly.

This API is intended to be used if you want to build your own login page and you have added a SAML v2 login button to this page.

For example, if you built your own login page, you could add a Login with Pied Piper button to utilize a third party SAML v2 identity provider. When the user completes the SAML v2 login step, they will be redirected back to your application. This is done via a form submit (using the HTTP POST method). This POST will contain a parameter named SAMLResponse. 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. The SAMLResponse returned from the SAML v2 provider will be used to retrieve the user’s email address, if that user does not yet exist in FusionAuth the user will be created. If create registration 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 create registration 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 SAML v2 identity provider.

Request

Complete SAML v2 Login

URI

POST /api/identity-provider/login

Request Headers

X-Forwarded-For [String] Optional

The IP address of a client requesting authentication. If the IP address is provided it will be stored for login history of the user. 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, the request body value will take precedence.

X-FusionAuth-TenantId [String] Optional

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

applicationId [UUID] Required

The Id of the Application the user is to be logged into. This application must have SAML v2 login enabled for this request to succeed.

identityProviderId [UUID] Required

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

ipAddress [String] Optional

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.

data.samlResponse [String] Required

The SAMLResponse parameter from the form submit (via a POST request) from the SAML v2 identity provider.

metaData.device.description [String] Optional

A human readable description of the device represented by the device parameter.

metaData.device.lastAccessedAddress [String] Optional

The IP address of this login request.

metaData.device.name [String] Optional

A human readable name of the device represented by the device parameter.

metaData.device.type [String] Optional

The type of device represented by the device parameter. The following types may be specified:

  • BROWSER

  • DESKTOP

  • LAPTOP

  • MOBILE

  • OTHER

  • SERVER

  • TABLET

  • TV

  • UNKNOWN

noJWT [Boolean] Optional defaults 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.

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.

Table 6. Response Codes
Code Description

200

The authentication was successful. The response will contain the User object that was authenticated.

202

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

203

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

204

The login is pending action by the end user. Wait and try the request again.

212

The user’s email address has not yet been verified. The response will contain the User object that was authenticated.

242

The user was authenticated successfully. The user has two factor authentication enabled, the response will contain the twoFactorId to be used on the Complete Two Factor Authentication.

Example Response JSON
{
  "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
}

400

The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.

401

Unable to complete the login request. The user cannot be reconciled or logged in using the external identity provider.

404

The user was not found or the password was incorrect. The response will be empty.

409

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

410

The user has expired. 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.

503

The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body

refreshToken [String]

The refresh token that can be used to obtain a new access token once the provide 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.

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.

state [Object]

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.

token [String] Available since 1.16.0

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

user.active [Boolean]

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

user.birthDate [String]

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

user.connectorId [UUID] Available since 1.18.0

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

user.cleanSpeakId [UUID]

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.data [Object]

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

user.email [String]

The User’s email address.

user.expiry [Long]

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

user.firstName [String]

The first name of the User.

user.fullName [String]

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

user.id [UUID]

The User’s unique Id.

user.imageUrl [String]

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

user.insertInstant [Long]

The instant when user was created.

user.lastLoginInstant [Long]

The instant when the User logged in last.

user.lastName [String]

The User’s last name.

user.memberships [Array]

The list of memberships for the User.

user.memberships[x].data [Object]

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

user.memberships[x].groupId [UUID]

The Id of the Group of this membership.

user.memberships[x].id [UUID]

The unique Id of this membership.

user.memberships[x].insertInstant [Long]

The instant that the membership was created.

user.middleName [String]

The User’s middle name.

user.mobilePhone [String]

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

user.parentEmail [String] Available 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 value will only remain until the child is claimed by a parent.

user.passwordChangeRequired [Boolean]

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

user.passwordLastUpdateInstant [Long]

The instant that the User last changed their password.

user.preferredLanguages [Array<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.registrations [Array]

The list of registrations for the User.

user.registrations[x].applicationId [UUID]

The Id of the Application that this registration is for.

user.registrations[x].authenticationToken [String]

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

user.registrations[x].cleanSpeakId [UUID]

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].data [Object]

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

user.registrations[x].id [UUID]

The Id of this registration.

user.registrations[x].insertInstant [Long]

The instant that this registration was created.

user.registrations[x].lastLoginInstant [Long]

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

user.registrations[x].preferredLanguages [Array<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].roles [Array<String>]

The list of roles that the User has for this registration.

user.registrations[x].timezone [String]

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

user.registrations[x].tokens [Map<String,String>] Available since 1.1.0

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.

user.registrations[x].username [String]

The username of the User for this registration only.

user.registrations[x].usernameStatus [String]

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].verified [Boolean]

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

user.tenantId [UUID]

The Id of the Tenant that this User belongs to.

user.timezone [String]

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

user.twoFactorDelivery [String]

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

The possible values are:

  • None

  • TextMessage

user.twoFactorEnabled [Boolean]

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

user.username [String]

The username of the User.

user.usernameStatus [String]

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.verified [Boolean]

Whether or not the User’s email has been verified.

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",
    "imageUrl": "http://65.media.tumblr.com/tumblr_l7dbl0MHbU1qz50x3o1_500.png",
    "lastLoginInstant": 1471786483322,
    "lastName": "Doe",
    "middleName": "William",
    "mobilePhone": "303-555-1234",
    "passwordChangeRequired": false,
    "passwordLastUpdateInstant": 1471786483322,
    "preferredLanguages": [
      "en",
      "fr"
    ],
    "registrations": [
      {
        "applicationId": "10000000-0000-0002-0000-000000000001",
        "data": {
          "displayName": "Johnny",
          "favoriteSports": [
            "Football",
            "Basketball"
          ]
        },
        "id": "00000000-0000-0002-0000-000000000000",
        "insertInstant": 1446064706250,
        "lastLoginInstant": 1456064601291,
        "preferredLanguages": [
          "en",
          "fr"
        ],
        "roles": [
          "user",
          "community_helper"
        ],
        "tokens": {
          "Facebook": "nQbbBIzDhMXXfa7iDUoonz5zS",
          "19544aa2-d634-4859-b193-e57af82b5d12": "eu1SsrjsiDf3h3LryUjxHIKTS0yyrbiPcsKF3HDp"
        },
        "username": "johnny123",
        "usernameStatus": "ACTIVE"
      }
    ],
    "timezone": "America/Denver",
    "tenantId": "f24aca2b-ce4a-4dad-951a-c9d690e71415",
    "twoFactorEnabled": false,
    "usernameStatus": "ACTIVE",
    "username": "johnny123",
    "verified": true
  }
}

Response Cookies

access_token [String]

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_token [String]

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. :loginProvider!: