🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/apis/identity-providers/hypr.md.

HYPR API

Edit on GitHub
View Markdown
Available since 1.12.0

Create a HYPR Identity Provider#

Request#

API Key Authentication
Create a HYPR Identity Provider using a randomly generated Id
POST/api/identity-provider
OpenAPI Spec
API Key Authentication
Create a HYPR Identity Provider (client provided Id)
POST/api/identity-provider/{identityProviderId}
OpenAPI Spec

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

Request Parameters#

identityProviderId UUID optional Defaults to secure random UUID Available since 1.61.0Immutable

The Id to use for the new Identity Provider. If an Id is not provided, a secure random UUID is generated. If neither an Id nor identityProvider.name are provided, the legacy fixed HYPR IdP Id 778985b7-6fd8-414d-acf2-94f18fb7c7e0 will be used.

Request Body#
identityProvider.applicationConfiguration Map<UUID, Object> optional

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

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

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

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

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

identityProvider.applicationConfiguration[applicationId].relyingPartyApplicationId String optional

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

identityProvider.applicationConfiguration[applicationId].relyingPartyURL String optional

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

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

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

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

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

This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.

This property defaults to an empty map.

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

identityProvider.debug Boolean optional Defaults to false

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

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

identityProvider.enabled Boolean optional Defaults to false

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

identityProvider.lambdaConfiguration.reconcileId UUID optional Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

The specified Lambda Id must be of type HYPRReconcile

identityProvider.linkingStrategy String optional Defaults to Unsupported Available since 1.28.0

The linking strategy to use when creating the link between the HYPR Identity Provider and the user.

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

The possible values are:

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

The display name of this provider instance. Required when using a provided identityProviderId or identityProvider.tenantId.

identityProvider.relyingPartyApplicationId String required

The Relying Party Application identifier provided to you by HYPR.

identityProvider.relyingPartyURL String required

The Relying Party URL provided to you by HYPR.

identityProvider.source String optional Defaults to System Available since 1.65.0

The source of this Identity Provider.

The maximum length is 191 characters.

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

identityProvider.tenantId UUID optional Available since 1.62.0

The unique Id of the Tenant.

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

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

identityProvider.type String required

This field must be set to HYPR.

Example HYPR Request JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "debug": false,
    "enabled": true,
    "relyingPartyApplicationId": "piedPiper",
    "relyingPartyURL": "https://pipedpiper.biometric.software",
    "name": "HYPR Provider",
    "type": "HYPR"
  }
}

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
409A conflict was encountered processing this request.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

identityProvider.applicationConfiguration Map<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistration Boolean

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.applicationConfiguration[applicationId].relyingPartyApplicationId String

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

identityProvider.applicationConfiguration[applicationId].relyingPartyURL String

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

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

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

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

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

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

identityProvider.debug Boolean

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.enabled Boolean

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

identityProvider.id UUID

The Id of the provider.

identityProvider.insertInstant Long

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

identityProvider.lastUpdateInstant Long

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

identityProvider.lambdaConfiguration.reconcileId UUID Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

identityProvider.linkingStrategy String optional Defaults to Unsupported Available since 1.28.0

The linking strategy to use when creating the link between the HYPR Identity Provider and the user.

The possible values are:

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

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

identityProvider.relyingPartyApplicationId String

The Relying Party Application identifier provided to you by HYPR.

identityProvider.relyingPartyURL String

The Relying Party URL provided to you by HYPR.

identityProvider.source String Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantId UUID Available since 1.62.0

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

identityProvider.type String

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

Example HYPR Response JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "debug": false,
    "enabled": true,
    "id": "4e9d7c3a-5b2f-46a1-92c7-d1f6a8b5c3e2",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "HYPR Provider",
    "relyingPartyApplicationId": "piedPiper",
    "relyingPartyURL": "https://pipedpiper.biometric.software",
    "type": "HYPR"
  }
}

Retrieve a HYPR Identity Provider#

Request#

API Key Authentication
Retrieve a HYPR Identity Provider by Id
GET/api/identity-provider/{identityProviderId}
OpenAPI Spec
API Key Authentication
Retrieve HYPR Identity Providers by type
GET/api/identity-provider?type=HYPR
OpenAPI Spec

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
404The object you requested doesn't exist. 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.

Response Body#

identityProvider.applicationConfiguration Map<UUID, Object>

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

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.applicationConfiguration[applicationId].relyingPartyApplicationId String

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

identityProvider.applicationConfiguration[applicationId].relyingPartyURL String

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

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

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

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

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

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

identityProvider.debug Boolean

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.enabled Boolean

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

identityProvider.id UUID

The Id of the provider.

identityProvider.insertInstant Long

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

identityProvider.lastUpdateInstant Long

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

identityProvider.lambdaConfiguration.reconcileId UUID Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

identityProvider.linkingStrategy String optional Defaults to Unsupported Available since 1.28.0

The linking strategy to use when creating the link between the HYPR Identity Provider and the user.

The possible values are:

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

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

identityProvider.relyingPartyApplicationId String

The Relying Party Application identifier provided to you by HYPR.

identityProvider.relyingPartyURL String

The Relying Party URL provided to you by HYPR.

identityProvider.source String Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantId UUID Available since 1.62.0

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

identityProvider.type String

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

Example HYPR Response JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "debug": false,
    "enabled": true,
    "id": "4e9d7c3a-5b2f-46a1-92c7-d1f6a8b5c3e2",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "HYPR Provider",
    "relyingPartyApplicationId": "piedPiper",
    "relyingPartyURL": "https://pipedpiper.biometric.software",
    "type": "HYPR"
  }
}

Update a HYPR Identity Provider#

This API is used to update an existing HYPR Identity Provider.

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

Utilize the PATCH HTTP method to send specific changes to merge into an existing HYPR Identity Provider.

Request#

API Key Authentication
Update the HYPR Identity Provider by Id
PUT/api/identity-provider/{identityProviderId}
OpenAPI Spec
PATCH/api/identity-provider/{identityProviderId}
OpenAPI Spec
Note

For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:

For details, see the PATCH documentation.

Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.

API Key Authentication
Update the HYPR Identity Provider by type Deprecated
PUT/api/identity-provider?type=HYPR
PATCH/api/identity-provider?type=HYPR
Note

For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:

For details, see the PATCH documentation.

Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.

Deprecated since 1.61.0
Prefer updating by Id. Updating by type attempts to update the Identity Provider with the legacy fixed Id 778985b7-6fd8-414d-acf2-94f18fb7c7e0.

Request Body#

identityProvider.applicationConfiguration Map<UUID, Object> optional

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

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

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

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

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

identityProvider.applicationConfiguration[applicationId].relyingPartyApplicationId String optional

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

identityProvider.applicationConfiguration[applicationId].relyingPartyURL String optional

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

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

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

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

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

This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.

This property defaults to an empty map.

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

identityProvider.debug Boolean optional Defaults to false

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

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

identityProvider.enabled Boolean optional Defaults to false

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

identityProvider.lambdaConfiguration.reconcileId UUID optional Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

The specified Lambda Id must be of type HYPRReconcile

identityProvider.linkingStrategy String optional Defaults to Unsupported Available since 1.28.0

The linking strategy to use when creating the link between the HYPR Identity Provider and the user.

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

The possible values are:

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

The display name of this provider instance. Required when using a provided identityProviderId or identityProvider.tenantId.

identityProvider.relyingPartyApplicationId String required

The Relying Party Application identifier provided to you by HYPR.

identityProvider.relyingPartyURL String required

The Relying Party URL provided to you by HYPR.

identityProvider.source String optional Defaults to System Available since 1.65.0

The source of this Identity Provider.

The maximum length is 191 characters.

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

identityProvider.tenantId UUID optional Available since 1.62.0

The unique Id of the Tenant.

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

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

identityProvider.type String required

This field must be set to HYPR.

Example HYPR Request JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "debug": false,
    "enabled": true,
    "relyingPartyApplicationId": "piedPiper",
    "relyingPartyURL": "https://pipedpiper.biometric.software",
    "name": "HYPR Provider",
    "type": "HYPR"
  }
}

Response#

The response for this API contains the HYPR Identity Provider.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
404The object you are trying to update doesn't exist. The response will be empty.
409A conflict was encountered processing this request. If the response has a general error code of [retryableConflict], then the client should exponentially backoff and retry the request.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

identityProvider.applicationConfiguration Map<UUID, Object>

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

identityProvider.applicationConfiguration[applicationId].createRegistration Boolean

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.applicationConfiguration[applicationId].relyingPartyApplicationId String

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

identityProvider.applicationConfiguration[applicationId].relyingPartyURL String

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

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

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

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

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

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

identityProvider.debug Boolean

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.enabled Boolean

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

identityProvider.id UUID

The Id of the provider.

identityProvider.insertInstant Long

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

identityProvider.lastUpdateInstant Long

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

identityProvider.lambdaConfiguration.reconcileId UUID Available since 1.17.0

The unique Id of the lambda to used during the user reconcile process to map custom claims from the external identity provider to the FusionAuth user.

identityProvider.linkingStrategy String optional Defaults to Unsupported Available since 1.28.0

The linking strategy to use when creating the link between the HYPR Identity Provider and the user.

The possible values are:

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

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

identityProvider.relyingPartyApplicationId String

The Relying Party Application identifier provided to you by HYPR.

identityProvider.relyingPartyURL String

The Relying Party URL provided to you by HYPR.

identityProvider.source String Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantId UUID Available since 1.62.0

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

identityProvider.type String

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

Example HYPR Response JSON

{
  "identityProvider": {
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "debug": false,
    "enabled": true,
    "id": "4e9d7c3a-5b2f-46a1-92c7-d1f6a8b5c3e2",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "name": "HYPR Provider",
    "relyingPartyApplicationId": "piedPiper",
    "relyingPartyURL": "https://pipedpiper.biometric.software",
    "type": "HYPR"
  }
}

Delete a HYPR Identity Provider#

Request#

API Key Authentication
Delete a HYPR Identity Provider by Id
DELETE/api/identity-provider/{identityProviderId}
OpenAPI Spec
API Key Authentication
Delete a HYPR Identity Provider by type Deprecated
DELETE/api/identity-provider?type=HYPR
Deprecated since 1.61.0
Prefer deleting by Id. Deleting by type attempts to delete the Identity Provider with the legacy fixed Id 778985b7-6fd8-414d-acf2-94f18fb7c7e0.

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful.
400The 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.
401You 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.
404The object you requested doesn't exist. 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.

Start the HYPR Login Request#

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

Request#

No Authentication Required
Start a login request
POST/api/identity-provider/start
OpenAPI Spec

Request Body#

applicationId UUID required

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

identityProviderId UUID required

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

connectionTestId String optional Available since 1.65.0

The Id of an identity provider connection test returned by the Start an Identity Provider Connection Test API.

loginId String required

The login identifier of the user. The login identifier can be either the email or the username.

Example Request JSON

{
  "applicationId": "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
  "identityProviderId": "778985b7-6fd8-414d-acf2-94f18fb7c7e0",
  "loginId": "user@example.com"
}

Response#

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

CodeDescription
202The request completed successfully. The response will contain the code to be used to complete the login request.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.
404The user was not found or the password was incorrect. 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.
code String

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

Example Response JSON

{
  "code": "id62bb157cb5a84abe858e0877a39bccda"
}

Complete the HYPR Login#

This API allows you to complete a HYPR login after authenticating a user using the HYPR API. If you are using the FusionAuth login UI with the HYPR 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 the HYPR login button to your own login page and you then need to complete the login with FusionAuth.

The user must exist in FusionAuth to utilize this API, and you must Start the HYPR Login Request before calling this.

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 is useful if you wish to manually provision users and then subsequently allow them to login with HYPR.

Request#

No Authentication Required
Complete HYPR Login
POST/api/identity-provider/login
OpenAPI Spec

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 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-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 HYPR login enabled for this request to succeed.

data.code String required

The code returned from the Start Login API.

identityProviderId UUID required

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

connectionTestId String optional Available since 1.65.0

The Id of an identity provider connection test returned by the Start an Identity Provider Connection Test API.

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.

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

newDevice Boolean optional Defaults to false

Indicates that this device has never been used by this user to log in before. One of many signals used to decide whether to issue an MFA challenge as part of Intelligent MFA or the MFA Requirement Lambda. When true, triggers the New Device Webhook.

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 used, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.

noLink Boolean optional Defaults to false Available 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": {
    "code": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
  },
  "identityProviderId": "778985b7-6fd8-414d-acf2-94f18fb7c7e0",
  "ipAddress": "192.168.1.42"
}

Response#

The response for this API contains the User object.

Response Cookies#

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#

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.