Facebook API

Edit on GitHubView Markdown
On this page
Available since 1.1.0

The Facebook identity provider type will use the Facebook OAuth login API. It will provide a Login with Facebook button on FusionAuth's login page that will leverage the Facebook login pop-up dialog. Additionally, this identity provider type will call Facebook's Graph API to load additional details about the user and store them in FusionAuth.

The email address returned by the Facebook Graph API will be used to create or lookup the existing user. Additional claims returned by Facebook can be used to reconcile the User to FusionAuth by using a Facebook Reconcile Lambda. Unless you assign a reconcile lambda to this provider, on the email address will be used from the available claims returned by Facebook.

When the picture field is not requested FusionAuth will also call Facebook's /me/picture API to load the user's profile image and store it as the imageUrl in FusionAuth. When the picture field is requested, the user's profile image will be returned by the /me API and a second request to the /me/picture endpoint will not be required.

FusionAuth will also store the Facebook long-lived token returned from the /oauth/access_token (after presenting the login token) 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 Facebook APIs on behalf of the user if desired.

The Facebook Identity Provider stores a long-lived token. More about this token.

Note

Prior to version 1.28.0, the token was stored in the UserRegistration object, in the tokens Map.

Please note if an idp_hint is appended to the OAuth Authorize endpoint, then the interaction behavior will be defaulted to redirect, even if popup interaction is explicitly configured.

Create a Facebook Identity Provider#

Request#

API Key Authentication
Create a Facebook Identity Provider using a randomly generated Id
POST/api/identity-provider
OpenAPI Spec
API Key Authentication
Create a Facebook Identity Provider with the provided unique Id
POST/api/identity-provider/{identityProviderId}
OpenAPI Spec

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

Request Parameters#

identityProviderId
  • Type: UUID
  • Optional
  • Defaults to secure random UUID
  • Available since 1.61.0
  • Immutable

The Id to use for the new Identity Provider. If an Id is not provided, a secure random UUID is generated. If neither an Id nor identityProvider.name are provided, the legacy fixed Facebook IdP Id 56abdcc7-8bd9-4321-9621-4e9bbebae494 will be used.

Request Body#
identityProvider.appId
  • Type: String
  • Required

The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.applicationConfiguration
  • Optional

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

identityProvider.applicationConfiguration[applicationId].appId
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].buttonText
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].client_secret
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].createRegistration
  • Type: 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
  • Type: Boolean
  • Optional
  • Defaults to false

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

identityProvider.applicationConfiguration[applicationId].fields
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].permissions
  • Type: String
  • Optional

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

identityProvider.buttonText
  • Type: String
  • Required

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

identityProvider.client_secret
  • Type: String
  • Required

The top-level client secret to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.attributeMappings
  • Type: Map<String, String>
  • Optional
  • Available since 1.65.0

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

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

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

This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.

This property defaults to an empty map.

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

identityProvider.debug
  • Type: Boolean
  • Optional
  • Defaults to false
  • Available since 1.7.3

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

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

identityProvider.enabled
  • Type: Boolean
  • Optional
  • Defaults to false

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

identityProvider.fields
  • Type: String
  • Optional
  • Defaults to email

The top-level fields that you are requesting from Facebook.

Available since 1.11.0

The default value of email is now provided and stored in the database when this field is not specified. This is a required fields value for retrieving the user's email address from the Facebook Graph API. Prior to this version, the value was defaulted at run-time.

identityProvider.lambdaConfiguration.reconcileId
  • Type: UUID
  • Optional
  • Available since 1.17.0

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

The specified Lambda Id must be of type FacebookReconcile

identityProvider.linkingStrategy
  • Type: String
  • Optional
  • Defaults to LinkByEmail
  • Available since 1.28.0

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

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

The possible values are:

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

The login method to use for this Identity Provider.

The possible values are:

  • UsePopup - When logging in use a popup window and the Facebook JavaScript library.
  • UseRedirect - When logging in use the Facebook OAuth redirect login flow.
identityProvider.name
  • Type: String
  • Optional
  • Available since 1.61.0

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

identityProvider.permissions
  • Type: String
  • Optional
  • Defaults to email

The top-level permissions that your application is asking of the user's Facebook account.

Available since 1.11.0

The default value of email is now provided and stored in the database when this field is not specified. This is a required permissions value for the Facebook Login API to complete login. Prior to this version, the value not defaulted.

identityProvider.source
  • Type: String
  • Optional
  • Defaults to System
  • Available since 1.65.0

The source of this Identity Provider.

The maximum length is 191 characters.

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

identityProvider.tenantConfiguration
  • Type: Map<UUID, Object>
  • Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount
  • Type: Object
  • Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled
  • Type: Boolean
  • Defaults to false
  • Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks
  • Type: Integer
  • Defaults to 42
  • Available since 1.32.0

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
  • Type: UUID
  • Optional
  • Available since 1.62.0

The unique Id of the Tenant.

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

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

identityProvider.type
  • Type: String
  • Required

This field must be set to Facebook.

Example Facebook Request JSON
{
  "identityProvider": {
    "appId": "385572258114379",
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Facebook",
    "client_secret": "72417eb5aa454ef2373b361d721cb074",
    "debug": false,
    "enabled": true,
    "fields": "email",
    "name": "Facebook Provider",
    "permissions": "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Facebook"
  }
}

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
409A conflict was encountered processing this request.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

identityProvider.appId
  • Type: String

The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.applicationConfiguration

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

identityProvider.applicationConfiguration[applicationId].appId
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].buttonText
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].client_secret
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].createRegistration
  • Type: 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
  • Type: Boolean

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

identityProvider.applicationConfiguration[applicationId].fields
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].permissions
  • Type: String

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

identityProvider.buttonText
  • Type: String

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

identityProvider.client_secret
  • Type: String

The top-level client secret to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.attributeMappings
  • Type: Map<String, String>
  • Available since 1.65.0

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

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

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

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

identityProvider.debug
  • Type: Boolean
  • Available since 1.7.3

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

identityProvider.enabled
  • Type: Boolean

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

identityProvider.fields
  • Type: String

The top-level fields that you are requesting from Facebook.

identityProvider.id
  • Type: UUID

The Id of the provider.

identityProvider.insertInstant
  • Type: Long

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

identityProvider.lastUpdateInstant
  • Type: Long

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

identityProvider.lambdaConfiguration.reconcileId
  • Type: UUID
  • Available since 1.17.0

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

identityProvider.linkingStrategy
  • Type: String
  • Optional
  • Defaults to LinkByEmail
  • Available since 1.28.0

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

The possible values are:

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

The login method to use for this Identity Provider.

The possible values are:

  • UsePopup - When logging in use a popup window and the Facebook JavaScript library.
  • UseRedirect - When logging in use the Facebook OAuth redirect login flow.
identityProvider.name
  • Type: String

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

identityProvider.permissions
  • Type: String

The top-level permissions that your application is asking of the user's Facebook account.

identityProvider.source
  • Type: String
  • Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantConfiguration
  • Type: Map<UUID, Object>
  • Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount
  • Type: Object
  • Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled
  • Type: Boolean
  • Defaults to false
  • Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks
  • Type: Integer
  • Defaults to 42
  • Available since 1.32.0

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
  • Type: UUID
  • Available since 1.62.0

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

identityProvider.type
  • Type: String

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

Example Facebook Response JSON
{
  "identityProvider": {
    "appId": "385572258114379",
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Facebook",
    "client_secret": "72417eb5aa454ef2373b361d721cb074",
    "debug": false,
    "enabled": true,
    "fields": "email",
    "id": "e4b9c2d1-7f53-48a6-82d1-9c3f5a6b2e71",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "linkingStrategy": "LinkByEmail",
    "loginMethod": "UseRedirect",
    "name": "Facebook Provider",
    "permissions": "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Facebook"
  }
}

Retrieve a Facebook Identity Provider#

Request#

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

Request Parameters#

identityProviderId
  • Type: UUID
  • Required

The unique Id of the Facebook Identity Provider to retrieve.

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

identityProvider.appId
  • Type: String

The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.applicationConfiguration

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

identityProvider.applicationConfiguration[applicationId].appId
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].buttonText
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].client_secret
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].createRegistration
  • Type: 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
  • Type: Boolean

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

identityProvider.applicationConfiguration[applicationId].fields
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].permissions
  • Type: String

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

identityProvider.buttonText
  • Type: String

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

identityProvider.client_secret
  • Type: String

The top-level client secret to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.attributeMappings
  • Type: Map<String, String>
  • Available since 1.65.0

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

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

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

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

identityProvider.debug
  • Type: Boolean
  • Available since 1.7.3

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

identityProvider.enabled
  • Type: Boolean

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

identityProvider.fields
  • Type: String

The top-level fields that you are requesting from Facebook.

identityProvider.id
  • Type: UUID

The Id of the provider.

identityProvider.insertInstant
  • Type: Long

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

identityProvider.lastUpdateInstant
  • Type: Long

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

identityProvider.lambdaConfiguration.reconcileId
  • Type: UUID
  • Available since 1.17.0

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

identityProvider.linkingStrategy
  • Type: String
  • Optional
  • Defaults to LinkByEmail
  • Available since 1.28.0

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

The possible values are:

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

The login method to use for this Identity Provider.

The possible values are:

  • UsePopup - When logging in use a popup window and the Facebook JavaScript library.
  • UseRedirect - When logging in use the Facebook OAuth redirect login flow.
identityProvider.name
  • Type: String

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

identityProvider.permissions
  • Type: String

The top-level permissions that your application is asking of the user's Facebook account.

identityProvider.source
  • Type: String
  • Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantConfiguration
  • Type: Map<UUID, Object>
  • Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount
  • Type: Object
  • Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled
  • Type: Boolean
  • Defaults to false
  • Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks
  • Type: Integer
  • Defaults to 42
  • Available since 1.32.0

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
  • Type: UUID
  • Available since 1.62.0

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

identityProvider.type
  • Type: String

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

Example Facebook Response JSON
{
  "identityProvider": {
    "appId": "385572258114379",
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Facebook",
    "client_secret": "72417eb5aa454ef2373b361d721cb074",
    "debug": false,
    "enabled": true,
    "fields": "email",
    "id": "e4b9c2d1-7f53-48a6-82d1-9c3f5a6b2e71",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "linkingStrategy": "LinkByEmail",
    "loginMethod": "UseRedirect",
    "name": "Facebook Provider",
    "permissions": "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Facebook"
  }
}

Update a Facebook Identity Provider#

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

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

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

Request#

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

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

For details, see the PATCH documentation.

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

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

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

For details, see the PATCH documentation.

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

Deprecated since 1.61.0
Prefer updating by Id. Updating by type attempts to update the Identity Provider with the legacy fixed Id 56abdcc7-8bd9-4321-9621-4e9bbebae494.

Request Parameters#

identityProviderId
  • Type: UUID
  • Required
  • Immutable

The unique Id of the Facebook Identity Provider to update.

Request Body#
identityProvider.appId
  • Type: String
  • Required

The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.applicationConfiguration
  • Optional

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

identityProvider.applicationConfiguration[applicationId].appId
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].buttonText
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].client_Secret
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].createRegistration
  • Type: 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
  • Type: Boolean
  • Optional
  • Defaults to false

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

identityProvider.applicationConfiguration[applicationId].fields
  • Type: String
  • Optional

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

identityProvider.applicationConfiguration[applicationId].permissions
  • Type: String
  • Optional

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

identityProvider.buttonText
  • Type: String
  • Required

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

identityProvider.client_secret
  • Type: String
  • Required

The top-level client secret to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.attributeMappings
  • Type: Map<String, String>
  • Optional
  • Available since 1.65.0

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

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

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

This property is ignored when identityProvider.linkingStrategy is LinkAnonymously.

This property defaults to an empty map.

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

identityProvider.enabled
  • Type: Boolean
  • Optional
  • Defaults to false

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

identityProvider.fields
  • Type: String
  • Optional

The top-level fields that you are requesting from Facebook.

identityProvider.lambdaConfiguration.reconcileId
  • Type: UUID
  • Optional
  • Available since 1.17.0

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

The specified Lambda Id must be of type FacebookReconcile

identityProvider.linkingStrategy
  • Type: String
  • Optional
  • Defaults to LinkByEmail
  • Available since 1.28.0

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

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

The possible values are:

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

The login method to use for this Identity Provider.

The possible values are:

  • UsePopup - When logging in use a popup window and the Facebook JavaScript library.
  • UseRedirect - When logging in use the Facebook OAuth redirect login flow.
identityProvider.name
  • Type: String
  • Required
  • Available since 1.61.0

The display name of this provider instance.

identityProvider.tenantConfiguration
  • Type: Map<UUID, Object>
  • Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount
  • Type: Object
  • Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled
  • Type: Boolean
  • Defaults to false
  • Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks
  • Type: Integer
  • Defaults to 42
  • Available since 1.32.0

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.permissions
  • Type: String
  • Optional

The top-level permissions that your application is asking of the user's Facebook account.

identityProvider.source
  • Type: String
  • Optional
  • Defaults to System
  • Available since 1.65.0

The source of this Identity Provider.

The maximum length is 191 characters.

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

identityProvider.type
  • Type: String
  • Required

This field must be set to Facebook.

Example Facebook Request JSON
{
  "identityProvider": {
    "appId": "385572258114379",
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Facebook",
    "client_secret": "72417eb5aa454ef2373b361d721cb074",
    "debug": false,
    "enabled": true,
    "fields": "email",
    "name": "Facebook Provider",
    "permissions": "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Facebook"
  }
}

Response#

The response for this API contains a Facebook Identity Provider.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you are trying to update doesn't exist. The response will be empty.
409A conflict was encountered processing this request. If the response has a general error code of [retryableConflict], then the client should exponentially backoff and retry the request.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

identityProvider.appId
  • Type: String

The top-level Facebook appId for your Application. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.applicationConfiguration

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

identityProvider.applicationConfiguration[applicationId].appId
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].buttonText
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].client_secret
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].createRegistration
  • Type: 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
  • Type: Boolean

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

identityProvider.applicationConfiguration[applicationId].fields
  • Type: String

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

identityProvider.applicationConfiguration[applicationId].permissions
  • Type: String

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

identityProvider.buttonText
  • Type: String

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

identityProvider.client_secret
  • Type: String

The top-level client secret to use with the Facebook Identity Provider when retrieving the long-lived token. This value is retrieved from the Facebook developer website when you setup your Facebook developer account.

identityProvider.attributeMappings
  • Type: Map<String, String>
  • Available since 1.65.0

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

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

This configuration is ignored when identityProvider.linkingStrategy is LinkAnonymously.

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

identityProvider.debug
  • Type: Boolean
  • Available since 1.7.3

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

identityProvider.enabled
  • Type: Boolean

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

identityProvider.fields
  • Type: String

The top-level fields that you are requesting from Facebook.

identityProvider.id
  • Type: UUID

The Id of the provider.

identityProvider.insertInstant
  • Type: Long

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

identityProvider.lastUpdateInstant
  • Type: Long

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

identityProvider.lambdaConfiguration.reconcileId
  • Type: UUID
  • Available since 1.17.0

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

identityProvider.linkingStrategy
  • Type: String
  • Optional
  • Defaults to LinkByEmail
  • Available since 1.28.0

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

The possible values are:

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

The login method to use for this Identity Provider.

The possible values are:

  • UsePopup - When logging in use a popup window and the Facebook JavaScript library.
  • UseRedirect - When logging in use the Facebook OAuth redirect login flow.
identityProvider.name
  • Type: String

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

identityProvider.permissions
  • Type: String

The top-level permissions that your application is asking of the user's Facebook account.

identityProvider.source
  • Type: String
  • Available since 1.65.0

The source for this Identity Provider.

identityProvider.tenantConfiguration
  • Type: Map<UUID, Object>
  • Available since 1.32.0

The configuration for each Tenant that limits the number of links a user may have for a particular identity provider.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount
  • Type: Object
  • Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled
  • Type: Boolean
  • Defaults to false
  • Available since 1.32.0

When enabled, the number of identity provider links a user may create is enforced by maximumLinks.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.maximumLinks
  • Type: Integer
  • Defaults to 42
  • Available since 1.32.0

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
  • Type: UUID
  • Available since 1.62.0

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

identityProvider.type
  • Type: String

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

Example Facebook Response JSON
{
  "identityProvider": {
    "appId": "385572258114379",
    "applicationConfiguration": {
      "1c212e59-0d0e-6b1a-ad48-f4f92793be32": {
        "createRegistration": true,
        "enabled": true
      }
    },
    "buttonText": "Login with Facebook",
    "client_secret": "72417eb5aa454ef2373b361d721cb074",
    "debug": false,
    "enabled": true,
    "fields": "email",
    "id": "e4b9c2d1-7f53-48a6-82d1-9c3f5a6b2e71",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "linkingStrategy": "LinkByEmail",
    "loginMethod": "UseRedirect",
    "name": "Facebook Provider",
    "permissions": "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type": "Facebook"
  }
}

Delete a Facebook Identity Provider#

Request#

API Key Authentication
Delete a Facebook Identity Provider by Id
DELETE/api/identity-provider/{identityProviderId}
OpenAPI Spec
API Key Authentication
Delete a Facebook Identity Provider by type Deprecated
DELETE/api/identity-provider?type=Facebook
Deprecated since 1.61.0
Prefer deleting by Id. Deleting by type attempts to delete the Identity Provider with the legacy fixed Id 56abdcc7-8bd9-4321-9621-4e9bbebae494.

Request Parameters#

identityProviderId
  • Type: UUID
  • Required

The unique Id of the Facebook Identity Provider to delete.

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Complete a Facebook Login#

This API allows you to complete a Facebook login after authenticating a user using the Facebook API. If you are using the FusionAuth login UI with the Facebook 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 Facebook 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 Facebook" button and complete the Facebook authentication. When you complete the Facebook authentication you will have been returned an access token from Facebook. Using this API you can pass that access token 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 access token returned from Facebook 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 Facebook.

Request#

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

Request Headers#

X-Forwarded-For
  • Type: 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
  • Type: 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
  • Type: UUID
  • Required

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

data.code
  • Type: String
  • Optional
  • Available since 1.28.0

When using the authorization code grant, will have returned an authorization code. To complete the login request, provide the code and the redirect_uri parameters to allow FusionAuth to complete this grant by exchanging the authorization code for an access_token.

When using code you must also supply redirect_uri. If code is not provided, then token will be required.

data.redirect_uri
  • Type: String
  • Optional
  • Available since 1.28.0

The redirect URI that was provided to the authorization endpoint. This value will be sent to the Token Info API as the redirect_uri parameter.

When using code this field is required.

data.token
  • Type: String
  • Optional

When using a popup or other login mode where has already returned you through a JavaScript callback or other mechanism, you will send this value in the token parameter. FusionAuth will use this value to request user details and then complete the login.

When using token you do not have to supply redirect_uri. If token is not provided, then code will be required.

identityProviderId
  • Type: UUID
  • Required

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

connectionTestId
  • Type: String
  • Optional
  • Available since 1.65.0

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

ipAddress
  • Type: 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
  • Type: String
  • Optional

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

metaData.device.lastAccessedAddress
  • Type: String
  • Optional

The IP address of this login request.

metaData.device.name
  • Type: String
  • Optional

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

metaData.device.type
  • Type: String
  • Optional

The type of device represented by the device parameter. Prior to version 1.46.0, this value was restricted to the following types:

  • BROWSER
  • DESKTOP
  • LAPTOP
  • MOBILE
  • OTHER
  • SERVER
  • TABLET
  • TV
  • UNKNOWN
In version 1.46.0 and beyond, this value can be any string value you'd like, have fun with it!

newDevice
  • Type: 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
  • Type: 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
  • Type: Boolean
  • Optional
  • Defaults to false
  • Available since 1.29.0

When this value is set to true, if a link does not yet exist to a FusionAuth user, a 404 status code will be returned instead of using the requested linking strategy. This may be useful if you want to identify if a link exists before starting a full interactive workflow with the user to complete a link.

Example Request JSON using code and redirect_uri
{
  "applicationId": "10000000-0000-0002-0000-000000000001",
  "data": {
    "code": "ZSBxGPP9Ghyxd4QzSQeZv_MvIHuy_vBNKRVygPk_cJM",
    "redirect_uri": "https://login.piedpiper.com/oauth2/callback"
  },
  "identityProviderId": "56abdcc7-8bd9-4321-9621-4e9bbebae494",
  "ipAddress": "192.168.1.42"
}
Example Request JSON using token
{
  "applicationId": "10000000-0000-0002-0000-000000000001",
  "data": {
    "token": "AKR7cfPDC8"
  },
  "identityProviderId": "56abdcc7-8bd9-4321-9621-4e9bbebae494",
  "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.
Example Response JSON
{
  "changePasswordId": "XOgai4Ro68xfGiex0ngXiJ2bbhduM4Pm7h3lvF0xibQ",
  "changePasswordReason": "Expired"
}
204 The login is pending action by the end user. Wait and try the request again.
212 The user's email address has not yet been verified. The response will contain the User object that was authenticated. 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.
Example Response JSON
{
  "pendingIdPLinkId": "0TxfELqDE0d2Y6PqCkztz4o-lXdRyAscAXh8EAyRZsx"
}
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.
Example Response JSON
{
  "methods": [
    {
      "authenticator": {
        "algorithm": "HmacSHA1",
        "codeLength": 6,
        "timeStep": 30
      },
      "id": "2KSZ",
      "method": "authenticator"
    },
    {
      "email": "richard@fusionauth.io",
      "id": "KLRT",
      "method": "email"
    }
  ],
  "twoFactorId": "YkQY5Gsyo4RlfmDciBGRmvfj3RmatUqrbjoIZ19fmw4"
}
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.
Example Response JSON
{
  "actions": [
    {
      "actionId": "00000000-0000-0000-0000-000000000042",
      "actionerUserId": "00000000-0000-0001-0000-000000000000",
      "expiry": 1571786483322,
      "localizedName": "Prevent Login Action",
      "localizedReason": "Hard Lock",
      "name": "Prevent Login Action",
      "reason": "Hard Lock",
      "reasonCode": "hard_lock"
    }
  ]
}
410 The user has expired. The response will be empty.
500 There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503 The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.
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
  • Type: 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
  • Type: 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.

Related

APIs

Google API

Learn about the APIs for creating, retrieving, updating and disabling a Google identity provider.

fusionauth apirest apihttp api
APIs

Identity Provider API

Learn about the APIs for creating, retrieving, updating and deleting identity providers.

fusionauth apirest apihttp api
APIs

LinkedIn API

Learn about the APIs for creating, retrieving, updating and disabling a LinkedIn identity provider.

fusionauth apirest apihttp api
APIs

Apple API

Learn about the APIs for creating, retrieving, updating and disabling an Apple identity provider.

fusionauth apirest apihttp api