OpenID Connect API
On this page
1.1.0
OpenID Connect identity providers connect to external OpenID Connect 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 OpenID Connect, 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 also leverage the /userinfo API that is part of the OpenID Connect specification. The email address returned from the Userinfo response will be used to create or lookup the existing user. Additional claims from the Userinfo response can be used to reconcile the User in FusionAuth by using an OpenID Connect Reconcile Lambda. Unless you assign a reconcile lambda to this provider, on the email address will be used from the available claims returned by the OpenID Connect identity provider.
FusionAuth will also store the refresh_token returned from the external OpenID Connect provider, if such a token is provided, in the identityProviderLink object, in the identityProviderLink.token field. This object is accessible using the Link API.
The identityProviderLink object stores the token so that you can use it in your application to call APIs on behalf of the user if desired.
Calling APIs first requires a refresh grant to get a new access token.
Prior to version 1.28.0, the token was stored in the UserRegistration object, in the tokens Map.
Create an OpenID Connect Identity Provider#
Request#
OpenAPI Spec
OpenAPI Spec
The type property in the request JSON is used to determine that you are managing an OpenID Connect identity provider.
Request Parameters#
identityProviderIdThe Id to use for the new Identity Provider. If an Id is not provided, a secure random UUID is generated.
Request Body#
identityProvider.applicationConfiguration The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].buttonImageURL This is an optional Application specific override for the top level button image URL.
identityProvider.applicationConfiguration[applicationId].buttonText This is an optional Application specific override for the top level button text.
identityProvider.applicationConfiguration[applicationId].oauth2.client_id This is an optional Application specific override for the top level client id.
identityProvider.applicationConfiguration[applicationId].oauth2.client_secret This is an optional Application specific override for the top level client secret.
identityProvider.applicationConfiguration[applicationId].createRegistration 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 Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.applicationConfiguration[applicationId].oauth2.scope This is an optional Application specific override for the top level scope.
identityProvider.buttonImageURL The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.
identityProvider.buttonText The top-level button text to use on the FusionAuth login page for this Identity Provider.
identityProvider.attributeMappings 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 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.domains This is an optional list of domains that this OpenID Connect 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 OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.
identityProvider.enabled Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.lambdaConfiguration.reconcileId 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 OpenIDReconcile.
identityProvider.linkingStrategy The linking strategy to use when creating the link between the OpenID Connect 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 since1.37.0LinkAnonymously- 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.
When the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser and the email_verified claim is present on the response from the OpenID Connect Identity Provider and the value is false a link will not be established and an error will be returned indicating a link cannot be established using an unverified email address.
identityProvider.name The name of this OpenID Connect identity provider. This is only used for display purposes.
identityProvider.oauth2.authorization_endpoint The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.client_id The top-level client id for your Application.
identityProvider.oauth2.client_secret The top-level client secret to use with the OpenID Connect identity provider.
Required when identityProvider.oauth2.clientAuthenticationMethod is client_secret_basic or client_secret_post.
identityProvider.oauth2.clientAuthenticationMethod The client authentication method to use with the OpenID Connect identity provider. Possible values are:
client_secret_basicclient_secret_postnone
identityProvider.oauth2.emailClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the email address.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
identityProvider.oauth2.emailVerifiedClaim An optional configuration to modify the expected name of the claim returned by the IdP that indicates if the email is verified.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
When the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser and this claim is present and the value is false a link will not be established and an error will be returned indicating a link cannot be established using an unverified email address.
identityProvider.oauth2.issuer The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.
identityProvider.oauth2.scope The top-level scope that you are requesting from the OpenID Connect identity provider.
identityProvider.oauth2.token_endpoint The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.uniqueIdClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the user Id.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
identityProvider.oauth2.userinfo_endpoint The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.usernameClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the username.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
identityProvider.postRequest Set this value equal to true if you wish to use POST bindings with this OpenID Connect identity provider. The default value of false means that a redirect binding which uses a GET request will be used.
identityProvider.source The source of this Identity Provider.
The maximum length is 191 characters.
This value is only used on create. If provided on update, it is ignored and the existing value is preserved.
identityProvider.tenantConfiguration The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.
identityProvider.tenantId 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 This field must be set to OpenIDConnect.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"oauth2": {
"authorization_endpoint": "https://acme.com/oauth2/authorization",
"client_id": "191c23dc-b772-4558-bd21-dc1cbf74ae21",
"client_secret": "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
"clientAuthenticationMethod": "client_secret_basic",
"scope": "openid offline_access",
"token_endpoint": "https://acme.com/oauth2/token",
"userinfo_endpoint": "https://acme.com/oauth2/userinfo"
},
"buttonText": "Login with OpenID Connect",
"debug": false,
"enabled": true,
"name": "Super Awesome OpenID Connect Provider",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "OpenIDConnect"
}
}Response#
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 409 | A conflict was encountered processing this request. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body#
identityProvider.applicationConfiguration The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].buttonImageURL This is an optional Application specific override for the top level button image URL.
identityProvider.applicationConfiguration[applicationId].buttonText This is an optional Application specific override for the top level button text.
identityProvider.applicationConfiguration[applicationId].client_id This is an optional Application specific override for the top level client id.
identityProvider.applicationConfiguration[applicationId].client_secret This is an optional Application specific override for the top level client secret.
identityProvider.applicationConfiguration[applicationId].createRegistration 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 Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.applicationConfiguration[applicationId].scope This is an optional Application specific override for the top level scope.
identityProvider.buttonImageURL The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.
identityProvider.buttonText The top-level button text to use on the FusionAuth login page for this Identity Provider.
identityProvider.attributeMappings 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 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 Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.domains This is an optional list of domains that this OpenID Connect 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 OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.
identityProvider.id The Id of the provider.
identityProvider.insertInstant The instant that the provider was added to the FusionAuth database.
identityProvider.lastUpdateInstant The instant that the provider was updated in the FusionAuth database.
identityProvider.lambdaConfiguration.reconcileId 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 The linking strategy to use when creating the link between the OpenID Connect Identity Provider and the user.
The possible values are:
CreatePendingLink- Create pending link.Disabled- Disables linking automatically. Available since1.37.0LinkAnonymously- 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 The name of this OpenID Connect identity provider. This is only used for display purposes.
identityProvider.oauth2.authorization_endpoint The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.client_id The top-level client id for your Application.
identityProvider.oauth2.client_secret The top-level client secret to use with the OpenID Connect identity provider.
identityProvider.oauth2.clientAuthenticationMethod The client authentication method to use with the OpenID Connect identity provider. Possible values are:
client_secret_basicclient_secret_postnone
identityProvider.oauth2.emailClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the email address.
identityProvider.oauth2.issuer The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.
identityProvider.oauth2.scope The top-level scope that you are requesting from the OpenID Connect identity provider.
identityProvider.oauth2.token_endpoint The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.uniqueIdClaim The optional configuration to modify the expected name of the claim returned by the IdP that contains the user Id.
identityProvider.oauth2.userinfo_endpoint The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.usernameClaim The optional configuration to modify the expected name of the claim returned by the IdP that contains the username.
identityProvider.postRequest When this value is equal to true POST bindings will be used instead of the default redirect bindings which utilize an HTTP GET request.
identityProvider.source The source for this Identity Provider.
identityProvider.tenantConfiguration The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.
identityProvider.tenantId 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 The type of this provider, this field will always be set to OpenIDConnect.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"oauth2": {
"authorization_endpoint": "https://acme.com/oauth2/authorization",
"client_id": "191c23dc-b772-4558-bd21-dc1cbf74ae21",
"client_secret": "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
"clientAuthenticationMethod": "client_secret_basic",
"emailClaim": "email",
"scope": "openid offline_access",
"token_endpoint": "https://acme.com/oauth2/token",
"userinfo_endpoint": "https://acme.com/oauth2/userinfo"
},
"buttonText": "Login with OpenID Connect",
"debug": false,
"enabled": true,
"id": "19544aa2-d634-4859-b193-e57af82b5d12",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Super Awesome OpenID Connect Provider",
"postRequest": false,
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "OpenIDConnect"
}
}Retrieve an OpenID Connect Identity Provider#
Request#
OpenAPI Spec
Request Parameters#
identityProviderIdThe unique Id of the OpenID Connect Identity Provider to retrieve.
Response#
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body#
identityProvider.applicationConfiguration The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].buttonImageURL This is an optional Application specific override for the top level button image URL.
identityProvider.applicationConfiguration[applicationId].buttonText This is an optional Application specific override for the top level button text.
identityProvider.applicationConfiguration[applicationId].client_id This is an optional Application specific override for the top level client id.
identityProvider.applicationConfiguration[applicationId].client_secret This is an optional Application specific override for the top level client secret.
identityProvider.applicationConfiguration[applicationId].createRegistration 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 Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.applicationConfiguration[applicationId].scope This is an optional Application specific override for the top level scope.
identityProvider.buttonImageURL The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.
identityProvider.buttonText The top-level button text to use on the FusionAuth login page for this Identity Provider.
identityProvider.attributeMappings 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 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 Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.domains This is an optional list of domains that this OpenID Connect 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 OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.
identityProvider.id The Id of the provider.
identityProvider.insertInstant The instant that the provider was added to the FusionAuth database.
identityProvider.lastUpdateInstant The instant that the provider was updated in the FusionAuth database.
identityProvider.lambdaConfiguration.reconcileId 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 The linking strategy to use when creating the link between the OpenID Connect Identity Provider and the user.
The possible values are:
CreatePendingLink- Create pending link.Disabled- Disables linking automatically. Available since1.37.0LinkAnonymously- 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 The name of this OpenID Connect identity provider. This is only used for display purposes.
identityProvider.oauth2.authorization_endpoint The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.client_id The top-level client id for your Application.
identityProvider.oauth2.client_secret The top-level client secret to use with the OpenID Connect identity provider.
identityProvider.oauth2.clientAuthenticationMethod The client authentication method to use with the OpenID Connect identity provider. Possible values are:
client_secret_basicclient_secret_postnone
identityProvider.oauth2.emailClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the email address.
identityProvider.oauth2.issuer The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.
identityProvider.oauth2.scope The top-level scope that you are requesting from the OpenID Connect identity provider.
identityProvider.oauth2.token_endpoint The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.uniqueIdClaim The optional configuration to modify the expected name of the claim returned by the IdP that contains the user Id.
identityProvider.oauth2.userinfo_endpoint The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.usernameClaim The optional configuration to modify the expected name of the claim returned by the IdP that contains the username.
identityProvider.postRequest When this value is equal to true POST bindings will be used instead of the default redirect bindings which utilize an HTTP GET request.
identityProvider.source The source for this Identity Provider.
identityProvider.tenantConfiguration The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.
identityProvider.tenantId 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 The type of this provider, this field will always be set to OpenIDConnect.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"oauth2": {
"authorization_endpoint": "https://acme.com/oauth2/authorization",
"client_id": "191c23dc-b772-4558-bd21-dc1cbf74ae21",
"client_secret": "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
"clientAuthenticationMethod": "client_secret_basic",
"emailClaim": "email",
"scope": "openid offline_access",
"token_endpoint": "https://acme.com/oauth2/token",
"userinfo_endpoint": "https://acme.com/oauth2/userinfo"
},
"buttonText": "Login with OpenID Connect",
"debug": false,
"enabled": true,
"id": "19544aa2-d634-4859-b193-e57af82b5d12",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Super Awesome OpenID Connect Provider",
"postRequest": false,
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "OpenIDConnect"
}
}Update an OpenID Connect Identity Provider#
This API is used to update an existing OpenID Connect Identity Provider.
You must specify all of the properties of the OpenID Connect Identity Provider when calling this API with the PUT HTTP method. When used with PUT, this API doesn't merge the existing OpenID Connect Identity Provider and your new data. It replaces the existing OpenID Connect Identity Provider with your new data.
Utilize the PATCH HTTP method to send specific changes to merge into an existing OpenID Connect Identity Provider.
Request#
OpenAPI Spec
OpenAPI Spec
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:
- JSON Patch/RFC 6902:
application/json-patch+json - JSON Merge Patch/RFC 7396:
merge-patch+json
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.
Request Parameters#
identityProviderIdThe unique Id of the OpenID Connect Identity Provider to update.
Request Body#
identityProvider.applicationConfiguration The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].buttonImageURL This is an optional Application specific override for the top level button image URL.
identityProvider.applicationConfiguration[applicationId].buttonText This is an optional Application specific override for the top level button text.
identityProvider.applicationConfiguration[applicationId].oauth2.client_id This is an optional Application specific override for the top level client id.
identityProvider.applicationConfiguration[applicationId].oauth2.client_secret This is an optional Application specific override for the top level client secret.
identityProvider.applicationConfiguration[applicationId].createRegistration 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 Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.applicationConfiguration[applicationId].oauth2.scope This is an optional Application specific override for the top level scope.
identityProvider.buttonImageURL The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.
identityProvider.buttonText The top-level button text to use on the FusionAuth login page for this Identity Provider.
identityProvider.attributeMappings 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 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.domains This is an optional list of domains that this OpenID Connect 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 OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.
identityProvider.enabled Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.lambdaConfiguration.reconcileId 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 OpenIDReconcile.
identityProvider.linkingStrategy The linking strategy to use when creating the link between the OpenID Connect 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 since1.37.0LinkAnonymously- 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.
When the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser and the email_verified claim is present on the response from the OpenID Connect Identity Provider and the value is false a link will not be established and an error will be returned indicating a link cannot be established using an unverified email address.
identityProvider.name The name of this OpenID Connect identity provider. This is only used for display purposes.
identityProvider.oauth2.authorization_endpoint The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.client_id The top-level client id for your Application.
identityProvider.oauth2.client_secret The top-level client secret to use with the OpenID Connect identity provider.
Required when identityProvider.oauth2.clientAuthenticationMethod is client_secret_basic or client_secret_post.
identityProvider.oauth2.clientAuthenticationMethod The client authentication method to use with the OpenID Connect identity provider. Possible values are:
client_secret_basicclient_secret_postnone
identityProvider.oauth2.emailClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the email address.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
identityProvider.oauth2.emailVerifiedClaim An optional configuration to modify the expected name of the claim returned by the IdP that indicates if the email is verified.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
When the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser and this claim is present and the value is false a link will not be established and an error will be returned indicating a link cannot be established using an unverified email address.
identityProvider.oauth2.issuer The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.
identityProvider.oauth2.scope The top-level scope that you are requesting from the OpenID Connect identity provider.
identityProvider.oauth2.token_endpoint The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.uniqueIdClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the user Id.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
identityProvider.oauth2.userinfo_endpoint The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.usernameClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the username.
This claim will be resolved using the following precedence where the first occurrence will be used. The UserInfo response, followed by the id_token when present assuming the signature can be verified.
identityProvider.postRequest Set this value equal to true if you wish to use POST bindings with this OpenID Connect identity provider. The default value of false means that a redirect binding which uses a GET request will be used.
identityProvider.source The source of this Identity Provider.
The maximum length is 191 characters.
This value is only used on create. If provided on update, it is ignored and the existing value is preserved.
identityProvider.tenantConfiguration The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.
identityProvider.tenantId 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 This field must be set to OpenIDConnect.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"oauth2": {
"authorization_endpoint": "https://acme.com/oauth2/authorization",
"client_id": "191c23dc-b772-4558-bd21-dc1cbf74ae21",
"client_secret": "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
"clientAuthenticationMethod": "client_secret_basic",
"scope": "openid offline_access",
"token_endpoint": "https://acme.com/oauth2/token",
"userinfo_endpoint": "https://acme.com/oauth2/userinfo"
},
"buttonText": "Login with OpenID Connect",
"debug": false,
"enabled": true,
"name": "Super Awesome OpenID Connect Provider",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "OpenIDConnect"
}
}Response#
The response for this API contains the OpenID Connect Identity Provider that was updated.
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you are trying to update doesn't exist. The response will be empty. |
| 409 | A 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. |
| 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 The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].buttonImageURL This is an optional Application specific override for the top level button image URL.
identityProvider.applicationConfiguration[applicationId].buttonText This is an optional Application specific override for the top level button text.
identityProvider.applicationConfiguration[applicationId].client_id This is an optional Application specific override for the top level client id.
identityProvider.applicationConfiguration[applicationId].client_secret This is an optional Application specific override for the top level client secret.
identityProvider.applicationConfiguration[applicationId].createRegistration 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 Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.applicationConfiguration[applicationId].scope This is an optional Application specific override for the top level scope.
identityProvider.buttonImageURL The top-level button image (URL) to use on the FusionAuth login page for this Identity Provider.
identityProvider.buttonText The top-level button text to use on the FusionAuth login page for this Identity Provider.
identityProvider.attributeMappings 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 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 Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.domains This is an optional list of domains that this OpenID Connect 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 OpenID Connect identity provider should be used. If an OpenID Connect provider should be used, the browser is redirected to the authorization endpoint of that identity provider. Otherwise, the password field is revealed on the form so that the user can login using FusionAuth.
identityProvider.id The Id of the provider.
identityProvider.insertInstant The instant that the provider was added to the FusionAuth database.
identityProvider.lastUpdateInstant The instant that the provider was updated in the FusionAuth database.
identityProvider.lambdaConfiguration.reconcileId 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 The linking strategy to use when creating the link between the OpenID Connect Identity Provider and the user.
The possible values are:
CreatePendingLink- Create pending link.Disabled- Disables linking automatically. Available since1.37.0LinkAnonymously- 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 The name of this OpenID Connect identity provider. This is only used for display purposes.
identityProvider.oauth2.authorization_endpoint The top-level authorization endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the authorization endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.client_id The top-level client id for your Application.
identityProvider.oauth2.client_secret The top-level client secret to use with the OpenID Connect identity provider.
identityProvider.oauth2.clientAuthenticationMethod The client authentication method to use with the OpenID Connect identity provider. Possible values are:
client_secret_basicclient_secret_postnone
identityProvider.oauth2.emailClaim An optional configuration to modify the expected name of the claim returned by the IdP that contains the email address.
identityProvider.oauth2.issuer The top-level issuer URI for the OpenID Connect identity provider. If this is provided, the authorization endpoint, token endpoint and userinfo endpoint will all be resolved using the issuer URI plus /.well-known/openid-configuration.
identityProvider.oauth2.scope The top-level scope that you are requesting from the OpenID Connect identity provider.
identityProvider.oauth2.token_endpoint The top-level token endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the token endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.uniqueIdClaim The optional configuration to modify the expected name of the claim returned by the IdP that contains the user Id.
identityProvider.oauth2.userinfo_endpoint The top-level userinfo endpoint for the OpenID Connect identity provider. You can leave this blank if you provide the issuer field, which will be used to make a request to the OpenID Connect .well-known endpoint in order to dynamically resolve the userinfo endpoint. If you provide an issuer then this field will be ignored.
identityProvider.oauth2.usernameClaim The optional configuration to modify the expected name of the claim returned by the IdP that contains the username.
identityProvider.postRequest When this value is equal to true POST bindings will be used instead of the default redirect bindings which utilize an HTTP GET request.
identityProvider.source The source for this Identity Provider.
identityProvider.tenantConfiguration The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks The maximum number of links that a user can have for a particular identity provider. This configuration is specific to this IdP. So a user can have more links than this number, but for this particular IdP, the number of links will be limited and enforced.
identityProvider.tenantId 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 The type of this provider, this field will always be set to OpenIDConnect.
{
"identityProvider": {
"applicationConfiguration": {
"1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
"createRegistration": true,
"enabled": true
}
},
"oauth2": {
"authorization_endpoint": "https://acme.com/oauth2/authorization",
"client_id": "191c23dc-b772-4558-bd21-dc1cbf74ae21",
"client_secret": "SUsnoP0pWUYfXvWbSe5pvj8Di5nAxOvO",
"clientAuthenticationMethod": "client_secret_basic",
"emailClaim": "email",
"scope": "openid offline_access",
"token_endpoint": "https://acme.com/oauth2/token",
"userinfo_endpoint": "https://acme.com/oauth2/userinfo"
},
"buttonText": "Login with OpenID Connect",
"debug": false,
"enabled": true,
"id": "19544aa2-d634-4859-b193-e57af82b5d12",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Super Awesome OpenID Connect Provider",
"postRequest": false,
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "OpenIDConnect"
}
}Delete an OpenID Connect Identity Provider#
Request#
OpenAPI Spec
Request Parameters#
identityProviderIdThe unique Id of the OpenID Connect Identity Provider to delete.
Response#
This API does not return a JSON response body.
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Complete an OpenID Connect Login#
This API allows you to complete a OpenID Connect login after authenticating a user using the OpenID Connect API. If you are using the FusionAuth login UI with the OpenID Connect 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 OpenID Connect login button to your own login page and you then need to complete the login with FusionAuth.
For example, if you built your own login page, you could add a "Login with OpenID Connect" button and complete the OpenID Connect authentication. When you complete the OpenID Connect authentication you will have been returned an authorization code from OpenID Connect. Using this API you can pass that authorization code to FusionAuth and we will complete the login workflow and reconcile the user to FusionAuth.
The user does not need to exist yet in FusionAuth to utilize this API, depending on the configured linking strategy. The authorization code returned from OpenID Connect will be used to retrieve the user's email address or username and if that user does not yet exist in FusionAuth the user may be created.
If createRegistration has been enabled for this identity provider and the user does not yet have a registration for this application, a registration will be automatically created for the user. The user will be assigned any default roles configured for the application.
If createRegistration has not been enabled, a registration will not be created if one does not yet exist. This is useful if you wish to manually provision users and then subsequently allow them to login with OpenID Connect.
Request#
OpenAPI Spec
Request Headers#
X-Forwarded-ForThe 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-TenantIdThe 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
applicationIdThe Id of the Application the user is to be logged into. This application must have OpenID Connect login enabled for this request to succeed.
data.code The authorization code, this is the code parameter that was returned on the Authorization redirect URI. This code will be sent to the Token endpoint as the code parameter.
data.redirect_uri The redirect URI that was provided to the OpenID Connect Authorization endpoint. This value will be sent to the Token endpoint as the redirect_uri parameter.
identityProviderIdThe unique Id of the identity provider to process this login request.
connectionTestIdThe Id of an identity provider connection test returned by the Start an Identity Provider Connection Test API.
ipAddressThe 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 A human readable description of the device represented by the device parameter.
metaData.device.lastAccessedAddress The IP address of this login request.
metaData.device.name A human readable name of the device represented by the device parameter.
metaData.device.type The type of device represented by the device parameter. Prior to version 1.46.0, this value was restricted to the following types:
BROWSERDESKTOPLAPTOPMOBILEOTHERSERVERTABLETTVUNKNOWN
1.46.0 and beyond, this value can be any string value you'd like, have fun with it!newDeviceIndicates 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.
noJWTWhen 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.
noLinkWhen 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.
{
"applicationId": "10000000-0000-0002-0000-000000000001",
"data": {
"code": "1179659262-VUvqmPjPcGC9BxwHdVxMGs0ka5Gmz91G0svPp2Z",
"redirect_uri": "https://login.piedpiper.com/oauth2/callback"
},
"identityProviderId": "19544aa2-d634-4859-b193-e57af82b5d12",
"ipAddress": "192.168.1.42"
}Response#
The response for this API contains the User object.
Response Cookies#
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. |
| 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 FormField, the response will contain the emailVerificationId that was generated for the user. |
| 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 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. |
| 232 | The 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. |
| 242 | The 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. |
| 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, 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. |
| 409 | The user is currently in an action that has prevented login. The response will contain the actions that prevented login. |
| 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. |
| 504 | One 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_tokenThe 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_tokenThe 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.
Related
Learn about the APIs for creating, retrieving, updating and deleting identity providers.
Learn about the APIs for creating, retrieving, updating and disabling a Facebook identity provider.
Learn about the APIs for creating, retrieving, updating and disabling a Google identity provider.
Learn about the APIs for creating, retrieving, updating and disabling a LinkedIn identity provider.