Skip to main content

Generic provider

The "Generic Provider" option allows you to add any OpenID Connect-certified provider that doesn't require custom API calls to get the required user information. To add a social sign-in provider, you need these details:

  • Client ID
  • Client Secret
  • Issuer URL - OpenID Connect server URL used by the provider to issue tokens

Follow these steps to add a generic, OIDC-certified social sign-in provider to your project using the Ory Console:

  1. Go to Authentication → Social Sign-In in the Ory Console.
  2. Click the Add A Generic Provider button.
  3. Define the Provider name. This name is used for identification purposes only.
  4. Paste the configuration details obtained from your social sign-in provider into the corresponding fields in the Console:
    • Client ID
    • Client Secret
    • Issuer URL
  5. Copy the Redirect URI from the Console and add it to your provider's configuration.
  6. Click Save Configuration to finish.
note

These steps cover the basic configuration of a social sign-in provider integration. At this point, the user experience is incomplete. To complete the configuration and ensure a smooth and secure user experience, configure the scopes and data mapping as described in the next section.

Additional configuration​

When adding a generic 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.

Scopes​

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.

Data mapping​

The Data mapping section allows you to map the claims returned by the sign-in provider to traits as defined in the identity schema.

note

For generic providers with claims_source=userinfo, the issuer claim will be ignored if the userinfo response is not signed. This behavior aligns with the OpenID Connect specification.

To define the mapping, create a Jsonnet code snippet. Read this document to learn more about Jsonnet data mapping.

danger

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 Ory Network.

Claims source​

The claims that the sign-in provider supplies can either be read from the identity token or from the UserInfo endpoint. The default behaviour is to use the identity token that was supplied through the provider's token endpoint.

To call the UserInfo endpoint (as discovered through the provider's .well-known/openid-configuration URL), set the claims_source key to userinfo.

selfservice:
  methods:
    oidc:
      config:
        providers:
          - id: generic # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
            provider: generic
            claims_source: userinfo # default: "id_token"
            # ...

Issuer URL mismatch​

Some OIDC providers incorrectly advertise an issuer URL in their openid-configuration that differs from the URL used to serve that configuration. This mismatch can cause validation errors when Ory attempts to verify the issuer URL.

Issuer URL validation is a critical security step to ensure tokens originate from the expected provider. If you encounter this issue, you can override the default behavior by explicitly specifying a discovery URL. This tells Ory to use the provided discovery URL instead of the issuer URL for validation purposes.

  1. Go to Authentication → Social Sign-In in the Ory Console.
  2. Click the Add a new OpenID Connect provider button or edit an existing generic provider.
  3. In the Issuer URL field, enter the URL advertised by the provider.
  4. Enable the Override discovery URL option.
  5. In the Discovery URL field, enter the URL where Ory can find the provider's openid-configuration.
  6. Click Save to finish.

Troubleshooting​

When you add a social sign-in provider, you can encounter common problems such as:

  • Redirect URI mismatch
  • Redirect loops during registration
  • Domain verification issues

To troubleshoot those issues, read Social sign-in troubleshooting.