External JWT API
1.1.0
This is a special type of identity provider that is only used via the JWT Reconcile API. This identity provider defines the claims inside the incoming JWT and how they map to fields in the FusionAuth User object.
This external JWT Identity Provider flow is not compatible with the hosted login pages. This integration is accessible through our API only.
Additionally, if you are integrating with any of the identity providers for which there is a provided Identity Provider integration (whether specific like Facebook or generic like OIDC), prefer those options over this provider.
In general, you should use the /api/identity-provider/login endpoint of another Identity Provider rather than the External JWT provider if one is available.
In order for this identity provider to use the JWT, it also needs the public key or HMAC secret that the JWT was signed with. FusionAuth will verify that the JWT is valid and has not expired. Once the JWT has been validated, FusionAuth will reconcile it to ensure that the User exists and is up-to-date.
FusionAuth will also store the true token provided in the refresh_token field returned from the request 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 true APIs on behalf of the user if desired.
Prior to version 1.28.0, the token was stored in the UserRegistration object, in the tokens Map.
Create an External JWT Identity Provider#
Request#
OpenAPI Spec
OpenAPI Spec
The type property in the request JSON is used to determine that you are managing an External JWT identity provider.
Request Parameters#
identityProviderId UUID optional Defaults to secure random UUID Immutable The Id to use for the new Identity Provider. If an id is not provided, a secure random UUID is generated.
Request Body#
identityProvider.applicationConfiguration Map<UUID, Optional> optional The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].createRegistration Boolean optional Defaults to true Determines if a UserRegistration is created for the User automatically or not. If a user doesn't exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
identityProvider.applicationConfiguration[applicationId].enabled Boolean optional Defaults to false Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.attributeMappings Map<String, String> optional Available since 1.65.0A 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.claimMap Map<String, String> optional A map of incoming claims to User fields, User data or Registration data. The key of the map is the incoming claim name from the configured identity provider. The following are allowed values:
birthDatefirstNamelastNamefullNamemiddleNamemobilePhoneimageUrltimezoneUserDataRegistrationData
identityProvider.debug Boolean optional Defaults to false Available since 1.7.3Determines 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.defaultKeyId required Deprecated This key will be used to verify the signature of the JWT. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key in identityProvider.verificationKeyIds or this value.
This field was optional prior to FusionAuth 1.69.0. In 1.69.0 and above, this field or at least one value in identityProvider.verificationKeyIds is required.
1.69.0In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.
identityProvider.domains optional An array of domains that are managed by 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.headerKeyParameter String required The name header claim that identifies the public key used to verify the signature. In most cases this be kid or x5t.
identityProvider.lambdaConfiguration.reconcileId UUID optional Available since 1.17.0The 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. This may be used in addition to, or in place of the claim mappings.
The specified Lambda Id must be of type ExternalJWTReconcile.
identityProvider.linkingStrategy String optional Defaults to LinkByEmail Available since 1.28.0The linking strategy to use when creating the link between the External JWT 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 External JWT 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 String required The name of the Identity Provider.
identityProvider.oauth2.authorization_endpoint String optional The authorization endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to perform the browser redirect to the OAuth2 authorize endpoint.
identityProvider.oauth2.emailClaim String optional Defaults to email The name of the claim that contains the user's email address. This will only be used when the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser.
identityProvider.oauth2.emailVerifiedClaim String optional Defaults to email_verified Available since 1.48.0The name of the claim that identities if the user's email address has been 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.token_endpoint String optional The token endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to complete the OAuth2 grant workflow.
identityProvider.oauth2.uniqueIdClaim String optional Defaults to sub The name of the claim that contains the user's unique user Id.
identityProvider.oauth2.usernameClaim String optional Defaults to preferred_username The name of the claim that contains the user's username. This will only be used when the identityProvider.linkingStrategy is equal to LinkByUsername or LinkByUsernameForExistingUser.
identityProvider.source String optional Defaults to System Available since 1.65.0The 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 Map<UUID, Object> Available since 1.32.0The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0The 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 UUID optional Available since 1.62.0The unique Id of the Tenant.
Providing a value creates an identity provider scoped to the specified tenant, otherwise a global identity provider is created. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. Global identity providers can be used with any tenant.
This value is read-only once the identity provider is created.
identityProvider.type String required This field must be set to ExternalJWT.
identityProvider.uniqueIdentityClaim String optional Deprecated The name of the claim that represents the unique identity of the User. This will generally be email or the name of the claim that provides the email address.
This parameter has been deprecated, prefer the use of uniqueIdClaim.
identityProvider.verificationKeyIds Array<UUID> required Available since 1.69.0Keys used to verify JWT signatures. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key from this list or defaultKeyId.
Before version 1.69.0, this field is not present; see identityProvider.defaultKeyId.
{
"identityProvider": {
"claimMap": {
"first_name": "firstName",
"last_name": "lastName",
"dept": "RegistrationData"
},
"debug": false,
"domains": [
"acme.com",
"acme.org"
],
"enabled": true,
"headerKeyParameter": "kid",
"name": "Acme Corp. ADFS",
"oauth2": {
"authorization_endpoint": "https://acme.com/adfs/oauth2/authorize?client_id=cf3b00da-9551-460a-ad18-33232e6cbff0&response_type=code&redirect_uri=https://acme.com/oauth2/redirect",
"emailClaim": "email",
"emailVerifiedClaim": "email_verified",
"token_endpoint": "https://acme.com/adfs/oauth2/token",
"uniqueIdClaim": "sub",
"usernameClaim": "preferred_username"
},
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "ExternalJWT",
"uniqueIdentityClaim": "email",
"verificationKeyIds": [
"8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"22b254ee-a258-447c-b42c-28d0dec1e9bf"
]
}
}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 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.attributeMappings Map<String, String> Available since 1.65.0A 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.claimMap Map<String,String> A map of incoming claims to User fields, User data or Registration data. The key of the map is the incoming claim name from the configured identity provider. The following are allowed values:
birthDatefirstNamelastNamefullNamemiddleNamemobilePhoneimageUrltimezoneUserDataRegistrationData
identityProvider.debug Boolean Available since 1.7.3Determines 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.defaultKeyId Deprecated This key will be used to verify the signature of the JWT. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key in identityProvider.verificationKeyIds or this value.
1.69.0In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.
identityProvider.domains Array<String> An array of domains that are managed by this Identity Provider.
identityProvider.enabled Boolean Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.headerKeyParameter String The name header claim that identifies the public key used to verify the signature. In most cases this be kid or x5t.
identityProvider.id UUID The unique identifier for the identity provider.
identityProvider.insertInstant Long The instant that the provider was added to the FusionAuth database.
identityProvider.lastUpdateInstant Long The instant that the provider was updated in the FusionAuth database.
identityProvider.lambdaConfiguration.reconcileId UUID Available since 1.17.0The 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 LinkByEmail The linking strategy to use when creating the link between the 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 String The name of the Identity Provider.
identityProvider.oauth2.authorization_endpoint String The authorization endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to perform the browser redirect to the OAuth2 authorize endpoint.
identityProvider.oauth2.emailClaim String The name of the claim that contains the user's email address. This will only be used when the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser.
identityProvider.oauth2.emailVerifiedClaim String The name of the claim that identities if the user's email address has been 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.token_endpoint String The token endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to complete the OAuth2 grant workflow.
identityProvider.oauth2.uniqueIdClaim String The name of the claim that contains the user's unique user Id.
identityProvider.oauth2.usernameClaim String The name of the claim that contains the user's username. This will only be used when the identityProvider.linkingStrategy is equal to LinkByUsername or LinkByUsernameForExistingUser.
identityProvider.source String Available since 1.65.0The source for this Identity Provider.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0The 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 UUID Available since 1.62.0The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.
identityProvider.type String The type of this provider, this field will always be set to ExternalJWT.
identityProvider.uniqueIdentityClaim String The name of the claim that represents the unique identity of the User. This will generally be email or the name of the claim that provides
the email address.
identityProvider.verificationKeyIds Array<UUID> Available since 1.69.0Keys used to verify JWT signatures. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key from this list or defaultKeyId.
In versions prior to 1.69.0, this field is not present; see identityProvider.defaultKeyId.
{
"identityProvider": {
"claimMap": {
"first_name": "firstName",
"last_name": "lastName",
"dept": "RegistrationData"
},
"debug": false,
"defaultKeyId": "8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"domains": [
"acme.com",
"acme.org"
],
"headerKeyParameter": "kid",
"id": "a4e78daa-33a6-4844-b081-7779af1f09a4",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Acme Corp. ADFS",
"oauth2": {
"authorization_endpoint": "https://acme.com/adfs/oauth2/authorize?client_id=cf3b00da-9551-460a-ad18-33232e6cbff0&response_type=code&redirect_uri=https://acme.com/oauth2/redirect",
"emailClaim": "email",
"emailVerifiedClaim": "email_verified",
"token_endpoint": "https://acme.com/adfs/oauth2/token",
"uniqueIdClaim": "sub",
"usernameClaim": "preferred_username"
},
"type": "ExternalJWT",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"uniqueIdentityClaim": "email",
"verificationKeyIds": [
"8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"22b254ee-a258-447c-b42c-28d0dec1e9bf"
]
}
}Retrieve an External JWT Identity Provider#
Request#
OpenAPI Spec
Request Parameters#
identityProviderId UUID required The unique Id of the 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 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.attributeMappings Map<String, String> Available since 1.65.0A 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.claimMap Map<String,String> A map of incoming claims to User fields, User data or Registration data. The key of the map is the incoming claim name from the configured identity provider. The following are allowed values:
birthDatefirstNamelastNamefullNamemiddleNamemobilePhoneimageUrltimezoneUserDataRegistrationData
identityProvider.debug Boolean Available since 1.7.3Determines 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.defaultKeyId Deprecated This key will be used to verify the signature of the JWT. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key in identityProvider.verificationKeyIds or this value.
1.69.0In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.
identityProvider.domains Array<String> An array of domains that are managed by this Identity Provider.
identityProvider.enabled Boolean Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.headerKeyParameter String The name header claim that identifies the public key used to verify the signature. In most cases this be kid or x5t.
identityProvider.id UUID The unique identifier for the identity provider.
identityProvider.insertInstant Long The instant that the provider was added to the FusionAuth database.
identityProvider.lastUpdateInstant Long The instant that the provider was updated in the FusionAuth database.
identityProvider.lambdaConfiguration.reconcileId UUID Available since 1.17.0The 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 The linking strategy to use when creating the link between the 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 String The name of the Identity Provider.
identityProvider.oauth2.authorization_endpoint String The authorization endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to perform the browser redirect to the OAuth2 authorize endpoint.
identityProvider.oauth2.emailClaim String The name of the claim that contains the user's email address. This will only be used when the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser.
identityProvider.oauth2.emailVerifiedClaim String The name of the claim that identities if the user's email address has been 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.token_endpoint String The token endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to complete the OAuth2 grant workflow.
identityProvider.oauth2.uniqueIdClaim String The name of the claim that contains the user's unique user Id.
identityProvider.oauth2.usernameClaim String The name of the claim that contains the user's username. This will only be used when the identityProvider.linkingStrategy is equal to LinkByUsername or LinkByUsernameForExistingUser.
identityProvider.source String Available since 1.65.0The source for this Identity Provider.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0The 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 UUID Available since 1.62.0The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.
identityProvider.type String The type of this provider, this field will always be set to ExternalJWT.
identityProvider.uniqueIdentityClaim String The name of the claim that represents the unique identity of the User. This will generally be email or the name of the claim that provides
the email address.
identityProvider.verificationKeyIds Array<UUID> Available since 1.69.0Keys used to verify JWT signatures. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key from this list or defaultKeyId.
In versions prior to 1.69.0, this field is not present; see identityProvider.defaultKeyId.
{
"identityProvider": {
"claimMap": {
"first_name": "firstName",
"last_name": "lastName",
"dept": "RegistrationData"
},
"debug": false,
"defaultKeyId": "8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"domains": [
"acme.com",
"acme.org"
],
"headerKeyParameter": "kid",
"id": "a4e78daa-33a6-4844-b081-7779af1f09a4",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Acme Corp. ADFS",
"oauth2": {
"authorization_endpoint": "https://acme.com/adfs/oauth2/authorize?client_id=cf3b00da-9551-460a-ad18-33232e6cbff0&response_type=code&redirect_uri=https://acme.com/oauth2/redirect",
"emailClaim": "email",
"emailVerifiedClaim": "email_verified",
"token_endpoint": "https://acme.com/adfs/oauth2/token",
"uniqueIdClaim": "sub",
"usernameClaim": "preferred_username"
},
"type": "ExternalJWT",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"uniqueIdentityClaim": "email",
"verificationKeyIds": [
"8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"22b254ee-a258-447c-b42c-28d0dec1e9bf"
]
}
}Update an External JWT Identity Provider#
This API is used to update an existing External JWT Identity Provider.
You must specify all of the properties of the External JWT Identity Provider when calling this API with the PUT HTTP method. When used with PUT, this API doesn't merge the existing External JWT Identity Provider and your new data. It replaces the existing External JWT Identity Provider with your new data.
Utilize the PATCH HTTP method to send specific changes to merge into an existing External JWT 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 Body#
identityProvider.applicationConfiguration Map<UUID, Optional> optional The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].createRegistration Boolean optional Defaults to true Determines if a UserRegistration is created for the User automatically or not. If a user doesn't exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
identityProvider.applicationConfiguration[applicationId].enabled Boolean optional Defaults to false Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.attributeMappings Map<String, String> optional Available since 1.65.0A 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.claimMap Map<String, String> optional A map of incoming claims to User fields, User data or Registration data. The key of the map is the incoming claim name from the configured identity provider. The following are allowed values:
birthDatefirstNamelastNamefullNamemiddleNamemobilePhoneimageUrltimezoneUserDataRegistrationData
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.defaultKeyId required Deprecated This key will be used to verify the signature of the JWT. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key in identityProvider.verificationKeyIds or this value.
This field was optional prior to FusionAuth 1.69.0. In 1.69.0 and above, this field or at least one value in identityProvider.verificationKeyIds is required.
1.69.0In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.
identityProvider.domains optional An array of domains that are managed by 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.headerKeyParameter String required The name header claim that identifies the public key used to verify the signature. In most cases this be kid or x5t.
identityProvider.lambdaConfiguration.reconcileId UUID optional Available since 1.17.0The 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. This may be used in addition to, or in place of the claim mappings.
The specified Lambda Id must be of type ExternalJWTReconcile.
identityProvider.linkingStrategy String optional The linking strategy to use when creating the link between the 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.
identityProvider.name String required The name of the Identity Provider.
identityProvider.oauth2.authorization_endpoint String optional The authorization endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to perform the browser redirect to the OAuth2 authorize endpoint.
identityProvider.oauth2.emailClaim String optional Defaults to email The name of the claim that contains the user's email address. This will only be used when the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser.
identityProvider.oauth2.emailVerifiedClaim String optional Defaults to email_verified Available since 1.48.0The name of the claim that identities if the user's email address has been 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.token_endpoint String optional The token endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to complete the OAuth2 grant workflow.
identityProvider.oauth2.uniqueIdClaim String optional Defaults to sub The name of the claim that contains the user's unique user Id.
identityProvider.oauth2.usernameClaim String optional Defaults to preferred_username The name of the claim that contains the user's username. This will only be used when the identityProvider.linkingStrategy is equal to LinkByUsername or LinkByUsernameForExistingUser.
identityProvider.source String optional Defaults to System Available since 1.65.0The 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 Map<UUID, Object> Available since 1.32.0The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0The 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 UUID optional Available since 1.62.0The unique Id of the Tenant.
Providing a value creates an identity provider scoped to the specified tenant, otherwise a global identity provider is created. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. Global identity providers can be used with any tenant.
This value is read-only once the identity provider is created.
identityProvider.type String required This field must be set to ExternalJWT.
identityProvider.uniqueIdentityClaim String optional Deprecated The name of the claim that represents the unique identity of the User. This will generally be email or the name of the claim that provides the email address.
This parameter has been deprecated, prefer the use of uniqueIdClaim.
identityProvider.verificationKeyIds Array<UUID> required Available since 1.69.0Keys used to verify JWT signatures. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key from this list or defaultKeyId.
Before version 1.69.0, this field is not present; see identityProvider.defaultKeyId.
{
"identityProvider": {
"claimMap": {
"first_name": "firstName",
"last_name": "lastName",
"dept": "RegistrationData"
},
"debug": false,
"domains": [
"acme.com",
"acme.org"
],
"enabled": true,
"headerKeyParameter": "kid",
"name": "Acme Corp. ADFS",
"oauth2": {
"authorization_endpoint": "https://acme.com/adfs/oauth2/authorize?client_id=cf3b00da-9551-460a-ad18-33232e6cbff0&response_type=code&redirect_uri=https://acme.com/oauth2/redirect",
"emailClaim": "email",
"emailVerifiedClaim": "email_verified",
"token_endpoint": "https://acme.com/adfs/oauth2/token",
"uniqueIdClaim": "sub",
"usernameClaim": "preferred_username"
},
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "ExternalJWT",
"uniqueIdentityClaim": "email",
"verificationKeyIds": [
"8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"22b254ee-a258-447c-b42c-28d0dec1e9bf"
]
}
}Request Parameters#
identityProviderId UUID required Immutable The unique Id of the Identity Provider to update.
Request Body#
identityProvider.applicationConfiguration Map<UUID, Optional> optional The configuration for each Application that the identity provider is enabled for.
identityProvider.applicationConfiguration[applicationId].createRegistration Boolean optional Defaults to true Determines if a UserRegistration is created for the User automatically or not. If a user doesn't exist in FusionAuth and logs in through an identity provider, this boolean controls whether or not FusionAuth creates a registration for the User in the Application they are logging into.
identityProvider.applicationConfiguration[applicationId].enabled Boolean optional Defaults to false Determines if this identity provider is enabled for the Application specified by the applicationId key.
identityProvider.attributeMappings Map<String, String> optional Available since 1.65.0A 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.claimMap Map<String, String> optional A map of incoming claims to User fields, User data or Registration data. The key of the map is the incoming claim name from the configured identity provider. The following are allowed values:
birthDatefirstNamelastNamefullNamemiddleNamemobilePhoneimageUrltimezoneUserDataRegistrationData
identityProvider.debug Boolean optional Defaults to false Available since 1.7.3Determines 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.defaultKeyId required Deprecated This key will be used to verify the signature of the JWT. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key in identityProvider.verificationKeyIds or this value.
This field was optional prior to FusionAuth 1.69.0. In 1.69.0 and above, this field or at least one value in identityProvider.verificationKeyIds is required.
1.69.0In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.
identityProvider.domains optional An array of domains that are managed by 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.headerKeyParameter String required The name header claim that identifies the public key used to verify the signature. In most cases this be kid or x5t.
identityProvider.lambdaConfiguration.reconcileId UUID optional Available since 1.17.0The 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. This may be used in addition to, or in place of the claim mappings.
The specified Lambda Id must be of type ExternalJWTReconcile.
identityProvider.linkingStrategy String optional Defaults to LinkByEmail Available since 1.28.0The linking strategy to use when creating the link between the External JWT 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 External JWT 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 String required The name of the Identity Provider.
identityProvider.oauth2.authorization_endpoint String optional The authorization endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to perform the browser redirect to the OAuth2 authorize endpoint.
identityProvider.oauth2.emailClaim String optional Defaults to email The name of the claim that contains the user's email address. This will only be used when the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser.
identityProvider.oauth2.emailVerifiedClaim String optional Defaults to email_verified Available since 1.48.0The name of the claim that identities if the user's email address has been 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.token_endpoint String optional The token endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to complete the OAuth2 grant workflow.
identityProvider.oauth2.uniqueIdClaim String optional Defaults to sub The name of the claim that contains the user's unique user Id.
identityProvider.oauth2.usernameClaim String optional Defaults to preferred_username The name of the claim that contains the user's username. This will only be used when the identityProvider.linkingStrategy is equal to LinkByUsername or LinkByUsernameForExistingUser.
identityProvider.source String optional Defaults to System Available since 1.65.0The 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 Map<UUID, Object> Available since 1.32.0The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0The 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 UUID optional Available since 1.62.0The unique Id of the Tenant.
Providing a value creates an identity provider scoped to the specified tenant, otherwise a global identity provider is created. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. Global identity providers can be used with any tenant.
This value is read-only once the identity provider is created.
identityProvider.type String required This field must be set to ExternalJWT.
identityProvider.uniqueIdentityClaim String optional Deprecated The name of the claim that represents the unique identity of the User. This will generally be email or the name of the claim that provides the email address.
This parameter has been deprecated, prefer the use of uniqueIdClaim.
identityProvider.verificationKeyIds Array<UUID> required Available since 1.69.0Keys used to verify JWT signatures. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key from this list or defaultKeyId.
Before version 1.69.0, this field is not present; see identityProvider.defaultKeyId.
{
"identityProvider": {
"claimMap": {
"first_name": "firstName",
"last_name": "lastName",
"dept": "RegistrationData"
},
"debug": false,
"domains": [
"acme.com",
"acme.org"
],
"enabled": true,
"headerKeyParameter": "kid",
"name": "Acme Corp. ADFS",
"oauth2": {
"authorization_endpoint": "https://acme.com/adfs/oauth2/authorize?client_id=cf3b00da-9551-460a-ad18-33232e6cbff0&response_type=code&redirect_uri=https://acme.com/oauth2/redirect",
"emailClaim": "email",
"emailVerifiedClaim": "email_verified",
"token_endpoint": "https://acme.com/adfs/oauth2/token",
"uniqueIdClaim": "sub",
"usernameClaim": "preferred_username"
},
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"type": "ExternalJWT",
"uniqueIdentityClaim": "email",
"verificationKeyIds": [
"8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"22b254ee-a258-447c-b42c-28d0dec1e9bf"
]
}
}Response#
The response for this API contains the external JWT 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 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.attributeMappings Map<String, String> Available since 1.65.0A 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.claimMap Map<String,String> A map of incoming claims to User fields, User data or Registration data. The key of the map is the incoming claim name from the configured identity provider. The following are allowed values:
birthDatefirstNamelastNamefullNamemiddleNamemobilePhoneimageUrltimezoneUserDataRegistrationData
identityProvider.debug Boolean Available since 1.7.3Determines 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.defaultKeyId Deprecated This key will be used to verify the signature of the JWT. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key in identityProvider.verificationKeyIds or this value.
1.69.0In version 1.69.0 and above, use identityProvider.verificationKeyIds. For backward compatibility, Fusionauth populates identityProvider.defaultKeyId with the first entry in identityProvider.verificationKeyIds.
identityProvider.domains Array<String> An array of domains that are managed by this Identity Provider.
identityProvider.enabled Boolean Determines if this provider is enabled. If it is false then it will be disabled globally.
identityProvider.headerKeyParameter String The name header claim that identifies the public key used to verify the signature. In most cases this be kid or x5t.
identityProvider.id UUID The unique identifier for the identity provider.
identityProvider.insertInstant Long The instant that the provider was added to the FusionAuth database.
identityProvider.lastUpdateInstant Long The instant that the provider was updated in the FusionAuth database.
identityProvider.lambdaConfiguration.reconcileId UUID Available since 1.17.0The 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 LinkByEmail The linking strategy to use when creating the link between the 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 String The name of the Identity Provider.
identityProvider.oauth2.authorization_endpoint String The authorization endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to perform the browser redirect to the OAuth2 authorize endpoint.
identityProvider.oauth2.emailClaim String The name of the claim that contains the user's email address. This will only be used when the identityProvider.linkingStrategy is equal to LinkByEmail or LinkByEmailForExistingUser.
identityProvider.oauth2.emailVerifiedClaim String The name of the claim that identities if the user's email address has been 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.token_endpoint String The token endpoint for this Identity Provider. This value is not utilized by FusionAuth is only provided to be returned by the Lookup Identity Provider API response. During integration you may then utilize this value to complete the OAuth2 grant workflow.
identityProvider.oauth2.uniqueIdClaim String The name of the claim that contains the user's unique user Id.
identityProvider.oauth2.usernameClaim String The name of the claim that contains the user's username. This will only be used when the identityProvider.linkingStrategy is equal to LinkByUsername or LinkByUsernameForExistingUser.
identityProvider.source String Available since 1.65.0The source for this Identity Provider.
identityProvider.tenantConfiguration Map<UUID, Object> Available since 1.32.0The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount Object Available since 1.32.0The policy that governs identity provider links on a Tenant.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled Boolean Defaults to false Available since 1.32.0When enabled, the number of identity provider links a user may create is enforced by maximumLinks.
identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks Integer Defaults to 42 Available since 1.32.0The 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 UUID Available since 1.62.0The unique Id of the Tenant. This value is present if the identity provider is tenant-scoped. Tenant-scoped identity providers can only be used to authenticate in the context of the specified tenant. This value is read-only once the key is created.
identityProvider.type String The type of this provider, this field will always be set to ExternalJWT.
identityProvider.uniqueIdentityClaim String The name of the claim that represents the unique identity of the User. This will generally be email or the name of the claim that provides
the email address.
identityProvider.verificationKeyIds Array<UUID> Available since 1.69.0Keys used to verify JWT signatures. In most cases, the JWT header contains the key identifier; FusionAuth uses this identifier to look up a key from this list or defaultKeyId.
In versions prior to 1.69.0, this field is not present; see identityProvider.defaultKeyId.
{
"identityProvider": {
"claimMap": {
"first_name": "firstName",
"last_name": "lastName",
"dept": "RegistrationData"
},
"debug": false,
"defaultKeyId": "8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"domains": [
"acme.com",
"acme.org"
],
"headerKeyParameter": "kid",
"id": "a4e78daa-33a6-4844-b081-7779af1f09a4",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"name": "Acme Corp. ADFS",
"oauth2": {
"authorization_endpoint": "https://acme.com/adfs/oauth2/authorize?client_id=cf3b00da-9551-460a-ad18-33232e6cbff0&response_type=code&redirect_uri=https://acme.com/oauth2/redirect",
"emailClaim": "email",
"emailVerifiedClaim": "email_verified",
"token_endpoint": "https://acme.com/adfs/oauth2/token",
"uniqueIdClaim": "sub",
"usernameClaim": "preferred_username"
},
"type": "ExternalJWT",
"tenantConfiguration": {
"e872a880-b14f-6d62-c312-cb40f22af465": {
"limitUserLinkCount": {
"enabled": false,
"maximumLinks": 42
}
}
},
"uniqueIdentityClaim": "email",
"verificationKeyIds": [
"8b0f67e9-e0e7-4359-b6a5-ac66e02278ca",
"22b254ee-a258-447c-b42c-28d0dec1e9bf"
]
}
}Delete an External JWT Identity Provider#
Request#
OpenAPI Spec
Request Parameters#
identityProviderId UUID required The unique Id of the 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 the External JWT Login#
This API allows you to complete an External JWT login after retrieving the external JWT and processing it.
For example, if you have a JWT representing a user, using this API you can pass that JWT returned from an external service 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 token returned 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.
Request#
OpenAPI Spec
Request Headers#
X-Forwarded-For String optional The IP address of a client requesting authentication. If the IP address is provided it will be stored in the user's login record. It is generally preferred to specify the IP address in the request body. If it is not provided in the request body this header value will be used if available. However, the request body value takes precedence.
X-FusionAuth-TenantId String optional The unique Id of the tenant used to scope this API request.
The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.
Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.
See Making an API request using a Tenant Id for additional information.
Request Body
applicationId UUID required The Id of the Application the user is to be logged into. This application must have External JWT login enabled for this request to succeed.
encodedJWT String required The encoded JWT which contains the user's identity information.
identityProviderId UUID required The unique Id of the identity provider to process this login request.
connectionTestId String optional Available since 1.65.0The Id of an identity provider connection test returned by the Start an Identity Provider Connection Test API.
ipAddress String optional The IP address of the end-user that is logging into FusionAuth. If this value is omitted FusionAuth will attempt to obtain the IP address of the client, the value will be that of the X-Forwarded-For header if provided or the last proxy that sent the request. The IP address will be stored in the User login history.
metaData.device.description String optional A human readable description of the device represented by the device parameter.
metaData.device.lastAccessedAddress String optional The IP address of this login request.
metaData.device.name String optional A human readable name of the device represented by the device parameter.
metaData.device.type String optional The type of device represented by the device parameter. Prior to version 1.46.0, this value was restricted to the following types:
BROWSERDESKTOPLAPTOPMOBILEOTHERSERVERTABLETTVUNKNOWN
1.46.0 and beyond, this value can be any string value you'd like, have fun with it!newDevice Boolean optional Defaults to false Indicates that this device has never been used by this user to log in before. One of many signals used to decide whether to issue an MFA challenge as part of Intelligent MFA or the MFA Requirement Lambda. When true, triggers the New Device Webhook.
noJWT Boolean optional Defaults to false When this value is set to true a JWT will not be issued as part of this request. The response body will not contain the token field, and the access_token and refresh_token cookies will not be written to the HTTP response. This optional parameter may be helpful when performing high volume authentication requests and the JWT is not being used, in this scenario removing the additional latency required to issue and sign the JWT may have a measurable cumulative effect on performance.
noLink Boolean optional Defaults to false Available since 1.29.0When 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.
refresh_token String optional A refresh token from the identity provider.
{
"applicationId": "10000000-0000-0002-0000-000000000001",
"encodedJWT": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODUxNDA5ODQsImlhdCI6MTQ4NTEzNzM4NCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiIyOWFjMGMxOC0wYjRhLTQyY2YtODJmYy0wM2Q1NzAzMThhMWQiLCJhcHBsaWNhdGlvbklkIjoiNzkxMDM3MzQtOTdhYi00ZDFhLWFmMzctZTAwNmQwNWQyOTUyIiwicm9sZXMiOltdfQ.Mp0Pcwsz5VECK11Kf2ZZNF_SMKu5CgBeLN9ZOP04kZo",
"identityProviderId": "7a9ed2eb-13e7-424a-b416-c9392c7192a1",
"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_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.