HYPR Identity Provider APIs
Overview
This API has been available since 1.12.0
Operations
Login Operations
Create the HYPR Identity Provider
Request
Create the HYPR Identity Provider
POST /api/identity-provider
The type property in the request JSON is used to determine that you are managing the HYPR identity provider.
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 totrue
-
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 tofalse
-
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.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
Available since 1.28.0Unsupported
-
The linking strategy to use when creating the link between the HYPR Identity Provider and the user.
The possible values are:
-
CreatePendingLink
- Do not automatically link, instead return a pending link identifier that can be used to link to an existing user. -
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.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.type [String] Required
-
This field must be set to
HYPR
.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"debug": false,
"enabled": true,
"relyingPartyApplicationId": "piedPiper",
"relyingPartyURL": "https://pipedpiper.biometric.software",
"type": "HYPR"
}
}
Response
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
- identityProvider.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.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 HYPR identity provider, which will always be
778985b7-6fd8-414d-acf2-94f18fb7c7e0
. - 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
Available since 1.28.0Unsupported
-
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 since1.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 the provider, this fill will always be set to
HYPR
. - 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.type [String]
-
The type of this provider, this field will always be set to
HYPR
.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"debug": false,
"enabled": true,
"id": "778985b7-6fd8-414d-acf2-94f18fb7c7e0",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "HYPR",
"relyingPartyApplicationId": "piedPiper",
"relyingPartyURL": "https://pipedpiper.biometric.software",
"type": "HYPR"
}
}
Retrieve the HYPR Identity Provider
There is only one HYPR Identity Provider, so this Identity Provider may be retrieved by type or Id.
Request
Retrieve the HYPR Identity Provider by type
GET /api/identity-provider?type=HYPR
Retrieve the HYPR Identity Provider by Id
GET /api/identity-provider/778985b7-6fd8-414d-acf2-94f18fb7c7e0
Response
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you requested doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
- identityProvider.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.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 HYPR identity provider, which will always be
778985b7-6fd8-414d-acf2-94f18fb7c7e0
. - 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
Available since 1.28.0Unsupported
-
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 since1.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 the provider, this fill will always be set to
HYPR
. - 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.type [String]
-
The type of this provider, this field will always be set to
HYPR
.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"debug": false,
"enabled": true,
"id": "778985b7-6fd8-414d-acf2-94f18fb7c7e0",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "HYPR",
"relyingPartyApplicationId": "piedPiper",
"relyingPartyURL": "https://pipedpiper.biometric.software",
"type": "HYPR"
}
}
Update the HYPR Identity Provider
This API is used to update an existing HYPR Identity Provider.
There is only one HYPR Identity Provider, so this Identity Provider may be updated by type or Id.
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
Update the HYPR Identity Provider by type
PUT /api/identity-provider?type=HYPR
PATCH /api/identity-provider?type=HYPR
Available since 1.39.0
When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the
PATCH
documentation for more information.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 anArray
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.
Update the HYPR Identity Provider by Id
PUT /api/identity-provider/778985b7-6fd8-414d-acf2-94f18fb7c7e0
PATCH /api/identity-provider/778985b7-6fd8-414d-acf2-94f18fb7c7e0
Available since 1.39.0
When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the
PATCH
documentation for more information.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 anArray
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 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 totrue
-
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 tofalse
-
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.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
Available since 1.28.0Unsupported
-
The linking strategy to use when creating the link between the HYPR Identity Provider and the user.
The possible values are:
-
CreatePendingLink
- Do not automatically link, instead return a pending link identifier that can be used to link to an existing user. -
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.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.type [String] Required
-
This field must be set to
HYPR
.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"debug": false,
"enabled": true,
"relyingPartyApplicationId": "piedPiper",
"relyingPartyURL": "https://pipedpiper.biometric.software",
"type": "HYPR"
}
}
Response
The response for this API contains the HYPR Identity Provider.
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you are trying to update doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
- identityProvider.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.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 HYPR identity provider, which will always be
778985b7-6fd8-414d-acf2-94f18fb7c7e0
. - 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
Available since 1.28.0Unsupported
-
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 since1.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 the provider, this fill will always be set to
HYPR
. - 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.type [String]
-
The type of this provider, this field will always be set to
HYPR
.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"debug": false,
"enabled": true,
"id": "778985b7-6fd8-414d-acf2-94f18fb7c7e0",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "HYPR",
"relyingPartyApplicationId": "piedPiper",
"relyingPartyURL": "https://pipedpiper.biometric.software",
"type": "HYPR"
}
}
Delete the HYPR Identity Provider
There is only one HYPR Identity Provider, so this Identity Provider may be deleted by type or Id.
Request
Delete the HYPR Identity Provider by type
DELETE /api/identity-provider?type=HYPR
Delete the HYPR Identity Provider by Id
DELETE /api/identity-provider/778985b7-6fd8-414d-acf2-94f18fb7c7e0
Response
This API does not return a JSON response body.
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. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you are trying to 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 the HYPR Login Request
This API is used to initiate a HYPR login request when integrating without the FusionAuth hosted login pages.
Request
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 HYPR login enabled for this request to succeed.
- identityProviderId [UUID] Required
-
The unique Id of the identity provider to process this login request.
For the HYPR identity provider, this value will always be
778985b7-6fd8-414d-acf2-94f18fb7c7e0
. - loginId [String] Required
-
The login identifier of the user. The login identifier can be either the email or the username.
{
"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.
Code | Description |
---|---|
202 |
The request completed successfully. The response will contain the |
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. |
404 |
The user was not found or the password was incorrect. 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
- code [String]
-
The code used to complete login using the Complete HYPR Login API.
{
"code": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
}
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
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 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.
For the HYPR identity provider, this value will always be
778985b7-6fd8-414d-acf2-94f18fb7c7e0
. - 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. 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 theaccess_token
andrefresh_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.
- 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, a404
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.
{
"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.
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 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 Example Response JSON
|
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. If the verification strategy has been set to |
213 |
The 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
Prior to version |
242 |
The user was authenticated successfully. The user has two factor authentication enabled. Since version Example Response JSON
|
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
|
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
- pendingIdPLinkId [String] Available since 1.28.0
-
The pending identity provider link Id. This value is created when logging in with an identity provider configured with a linking strategy of
Create a pending link
. It will only be included in the response body when this strategy is configured and a link does not yet exist for the user. It is used in conjunction with the Link APIs to complete a pending link. - refreshToken [String]
-
The refresh token that can be used to obtain a new access token once the provided one has expired.
Because a refresh token is per user and per application, this value will only be returned when an applicationId was provided on the login request and the user is registered to the application.
You must explicitly allow generation of refresh tokens when using the Login API. Configure the application.loginConfiguration.generateRefreshTokens setting via the API or enable the setting by navigating to the tab.
- refreshTokenId [String] Available since 1.37.0
-
When the refreshToken is returned in the response, this field will also be returned. This unique Id is the persistent identifier for this refresh token, and will not change even when using one-time use refresh tokens. This value may optionally be used to revoke the token using the Refresh Token API.
- 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).
- tokenExpirationInstant [Long] Available since 1.33.0
-
The instant the token will expire. If the response does not contain a token, this field will also be omitted from the response.
- user.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.breachedPasswordLastCheckedInstant [Long]
-
The instant this user’s password was last checked to determine if it is compromised.
- 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.data.email [String]
-
This field will be used as the email address if no user.email field is found.
This feature was removed in version 1.26.0 and added back in in 1.27.2.
- 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 the user was created.
- user.lastLoginInstant [Long]
-
The instant when the User logged in last.
- user.lastName [String]
-
The User’s last name.
- user.lastUpdateInstant [Long]
-
The instant when the User was last updated.
- 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 if 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 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. This will include registrations for inactive applications.
- 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>] Deprecated -
A map that contains tokens returned from identity providers.
For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name
Facebook
. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id.Removed in 1.28.0
The token returned and stored from the Identity Provider is now stored in the IdP link and is retrievable using the Identity Provider Link API.
- user.registrations
[x]
.username [String] -
The username of the User for this registration only. This is for display purposes and cannot be used to login.
- 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.
For additional information, see these tutorials:
- 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 Users to change this per-session. The string will be in an IANA time zone format.
- user.twoFactor.methods
[x]
.authenticator.algorithm [String] -
The algorithm used by the TOTP authenticator. With the current implementation, this will always be
HmacSHA1
. - user.twoFactor.methods
[x]
.authenticator.codeLength [Integer] -
The length of code generated by the TOTP. With the current implementation, this will always be
6
. - user.twoFactor.methods
[x]
.authenticator.timeStep [Integer] -
The time-step size in seconds. With the current implementation, this will always be 30.
- user.twoFactor.methods
[x]
.email [String] -
The value of the email address for this method. Only present if user.twoFactor.methods
[x]
.method isemail
. - user.twoFactor.methods
[x]
.id [String] -
The unique Id of the method.
- user.twoFactor.methods
[x]
.lastUsed [Boolean] -
true
if this method was used most recently. - user.twoFactor.methods
[x]
.method [String] -
The type of this method. There will also be an object with the same value containing additional information about this method. The possible values are:
-
authenticator
-
email
-
sms
-
- user.twoFactor.methods
[x]
.mobilePhone [String] -
The value of the mobile phone for this method. Only present if user.twoFactor.methods
[x]
.method issms
. - user.twoFactor.methods
[x]
.secret [String] -
A base64 encoded secret
- user.twoFactorDelivery [String] Deprecated
-
The User’s preferred delivery for verification codes during a two factor login request.
The possible values are:
-
None
-
TextMessage
Removed in version 1.26.0
-
- user.twoFactorEnabled [Boolean] Deprecated
-
Determines if the User has two factor authentication enabled for their account or not.
Removed in version 1.26.0
- 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.
For additional information, see these tutorials:
{
"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"
],
"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.
Feedback
How helpful was this page?
See a problem?
File an issue in our docs repo
Have a question or comment to share?
Visit the FusionAuth community forum.