To add Facebook as a social sign-in provider, you need a Facebook Developer account. Go to Facebook Developers to create one.
Configuration in Ory Console
Follow these steps to add Facebook as a social sign-in provider for your for your project using the Ory Console.
- Sign in to Ory Console and select Social Sign-in.
- Click the switch next to the Facebook logo to start the configuration.
- Copy the Redirect URI and save it for later use.
- In your Facebook Developers account, go to My Apps → Create App.
- Select Consumer and click Next.
- Enter you app's name and preferred contact email. Click Create App.
- In the "Facebook Login" card, click Set Up. Ignore the quickstart and select Settings → Basic from the sidebar.
- Copy the Client ID and Client secret from Facebook and paste them into the corresponding fields in the Ory Console.
- On Facebook Developers, click Save Changes.
- From the left navigation bar, select Facebook Login → Settings.
- Paste the redirect URI copied from Ory into the Valid OAuth redirect URIs and click Save Changes.
- In the Ory Console, click Save Configuration to enable Facebook as a social sign-in provider.
When adding a social sign-in provider, you can customize the integration by defining the OAuth scopes Ory requests from the provider and by setting up custom data mappings.
The Scopes section allows you to define the OAuth scopes Ory requests from the sign-in provider. Defining scopes allows you to interact with the provider's APIs on behalf of the user, or to access additional user data, which is exposed as claims for data mapping.
For Facebook, add the
To learn more about the scopes available for Facebook, read the related documentation.
The Data mapping section allows you to map the data returned by the sign-in provider to traits as defined in the identity schema.
To define the mapping, create a Jsonnet code snippet. Read this document to learn more about Jsonnet data mapping.
In this sample Jsonnet snippet, the user's
local claims = std.extVar('claims');
// The email might be empty if the user hasn't granted permissions for the email scope.
[if 'email' in claims then 'email' else null]: claims.email,
Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in The Ory Network.
Configuration using the Ory CLI
Follow these steps to add Facebook as a social sign-in provider to your project using the Ory CLI:
Create a Jsonnet code snippet to map the desired claims to the Ory Identity schema.
Encode the Jsonnet snippet with Base64 or host it under an URL accessible to The Ory Network.
Download the Ory Identities config from your project and save it to a file:
## List all available projects
ory list projects
## Get config
ory get identity-config <project-id> --format yaml > identity-config.yaml
Add the social sign-in provider configuration to the downloaded config. Add the Jsonnet snippet with mappings as a Base64 string or provide an URL to the file.
- id: facebook # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
client_id: .... # Replace this with the OAuth2 Client ID provided by Facebook app
client_secret: .... # Replace this with the OAuth2 Client Secret provided by Facebook app
# Alternatively, use an URL:
# mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4
# required for email and email_verified claims in the near future
# other supported scopes: user_gender, user_birthday
Update the Ory Identities (Ory Kratos) configuration using the file you worked with:
ory update identity-config <project-id> --file updated_config.yaml
Prevent having to log in after sign-up
When adding social sign-in providers manually, remember to add the
session hook to
after/oidc/hooks. If you don't add this
hook, users will have to log in again after signing up to get a session.
- hook: session