Facebook Identity Provider APIs

Overview

This API has been 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 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.

Finally, FusionAuth will call Facebook’s /oauth/access_token API to exchange the login token for a long-lived Facebook token. This token is stored in the UserRegistration object inside the tokens Map. This Map stores the tokens from the various identity providers so that you can use them in your application to call their APIs.

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.

Complete the Facebook Login

Create the Facebook Identity Provider

Request

Create the Facebook Identity Provider

URI

POST /api/identity-provider

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

Request Body

identityProvider.appId [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 [Map<UUID, Object>] Optional

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

identityProvider.applicationConfiguration[applicationId].appId [String] Optional

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

identityProvider.applicationConfiguration[applicationId].buttonText [String] Optional

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

identityProvider.applicationConfiguration[applicationId].client_secret [String] Optional

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

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean] Optional defaults to true

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

identityProvider.applicationConfiguration[applicationId].enabled [Boolean] Optional defaults to false

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

identityProvider.applicationConfiguration[applicationId].fields [String] Optional

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

identityProvider.applicationConfiguration[applicationId].permissions [String] Optional

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

identityProvider.buttonText [String] Required

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

identityProvider.client_secret [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.debug [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 [Boolean] Optional defaults to false

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

identityProvider.fields [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 [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 [String] Optional defaults to {idp_linking_strategy} Available since 1.28.0

The linking strategy to use when creating the link between the {idp_display_name} Identity Provider and the user.

The possible values are:

CreatePendingLink - Do not automatically link, instead return a pending link identifier that can be used to link to an existing user.
LinkAnonymously - Always create a link based upon the unique Id returned by the identify provider. A username or email is not required and will not be used to link the user. A reconcile lambda will not be used in this configuration.
LinkByEmail - Link to an existing user based upon email. A user will be created with the email returned by the identity provider if one does not already exist.
LinkByEmailForExistingUser - Only link to an existing user based upon email. A user will not be created if one does not already exist with email returned by the identity provider.
LinkByUsername - Link to an existing user based upon username. A user will be created with the username returned by the identity provider if one does not already exist.
LinkByUsernameForExistingUser - Only link to an existing user based upon username. A user will not be created if one does not already exist with username returned by the identity provider.

identityProvider.loginMethod [String] Optional defaults to UseRedirect 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 {idp_display_name} javascript library.
UseRedirect - When logging in use the {idp_display_name} Oauth redirect login flow.

identityProvider.permissions [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.tenantConfiguration [Map<UUID, Object>] Optional 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 [Object] Optional Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled [Integer] Optional 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 [Integer] Optional 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.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",
    "permissions" : "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type" : "Facebook"
  }
}

Response

Table 1. 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.
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.appId [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 [Map<UUID, Object>]

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

identityProvider.applicationConfiguration[applicationId].appId [String]

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

identityProvider.applicationConfiguration[applicationId].buttonText [String]

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

identityProvider.applicationConfiguration[applicationId].client_secret [String]

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

identityProvider.applicationConfiguration[applicationId].createRegistration [Boolean]

identityProvider.applicationConfiguration[applicationId].enabled [Boolean]

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

identityProvider.applicationConfiguration[applicationId].fields [String]

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

identityProvider.applicationConfiguration[applicationId].permissions [String]

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

identityProvider.buttonText [String]

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

identityProvider.client_secret [String]

identityProvider.debug [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 [Boolean]

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

identityProvider.fields [String]

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

identityProvider.id [UUID]

The Id of the Facebook identity provider, which will always be 56abdcc7-8bd9-4321-9621-4e9bbebae494.

identityProvider.insertInstant [Long]

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

identityProvider.lastUpdateInstant [Long]

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

identityProvider.lambdaConfiguration.reconcileId [UUID] Available since 1.17.0

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

identityProvider.linkingStrategy [String] Optional defaults to {idp_linking_strategy} Available since 1.28.0

The linking strategy to use when creating the link between the {idp_display_name} Identity Provider and the user.

The possible values are:

CreatePendingLink - Create pending link.
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 [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 {idp_display_name} javascript library.
UseRedirect - When logging in use the {idp_display_name} Oauth redirect login flow.

identityProvider.name [String]

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

identityProvider.permissions [String]

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

identityProvider.tenantConfiguration [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 [Object] Available since 1.32.0

The policy that governs identity provider links on a Tenant.

identityProvider.tenantConfiguration[tenantId].limitUserLinkCount.enabled [Integer] 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 [Integer] defaults to 42 Available since 1.32.0

identityProvider.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" : "56abdcc7-8bd9-4321-9621-4e9bbebae494",
    "insertInstant": 1595361142909,
    "lastUpdateInstant": 1595361143101,
    "linkingStrategy" : "LinkByEmail",
    "loginMethod": "UseRedirect",
    "name" : "Facebook",
    "permissions" : "email,profile_image",
    "tenantConfiguration": {
      "e872a880-b14f-6d62-c312-cb40f22af465": {
        "limitUserLinkCount": {
          "enabled": false,
          "maximumLinks": 42
        }
      }
    },
    "type" : "Facebook"
  }
}

Retrieve the Facebook Identity Provider

There is only one Facebook Identity Provider, so this Identity Provider may be retrieved by type or Id.

Request

Retrieve the Facebook Identity Provider by type

URI

GET /api/identity-provider?type=Facebook

Retrieve the Facebook Identity Provider by Id

URI

GET /api/identity-provider/56abdcc7-8bd9-4321-9621-4e9bbebae494

Response

Table 2. 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.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.