Configure an Authentication Provider Using OpenID Connect

Set Up a Registration Handler

Register an App in the OpenID Provider

1. Register your app on your OpenID provider’s website.
2. Modify the app settings and set the app domain, or Home Page URL, to Salesforce.
3. From the OpenID provider’s documentation, get these configuration values:
   • Client ID
   • Client Secret
   • Authorization Endpoint URL
   • Token Endpoint URL
   • User Info Endpoint URL

Define an Authentication Provider in Salesforce

1. From Setup, in the Quick Find box, enter Auth, and then select Auth. Providers.
2. Click New.
3. For the provider type, select OpenID Connect.
4. Enter a name for the provider.
5. Enter the URL suffix, which is used in the client configuration URLs. For example, if the URL suffix of your authentication provider is MyOpenIDConnectProvider, your SSO URL is similar to https://mydomain_url or site_url /services/auth/sso/OpenIDConnectProvider.
6. For Consumer Key, use the client ID from your OpenID provider.
7. For Consumer Secret, use the client secret from your OpenID provider.
8. For Authorize Endpoint URL, enter the base URL from your OpenID provider.
   

   Tip You can add query string parameters to the base URL, if necessary. For example, to get a refresh token from Google for offline access, use https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=force. You need the approval_prompt parameter to ask the user to accept the refresh action so that Google continues to provide refresh tokens after the first one.
9. Enter the token endpoint URL from your OpenID provider.
10. Enter the User Info Endpoint URL from your OpenID provider.
    

    Note If you want to integrate the provider with your API using OAuth, a User Info endpoint isn’t required.
11. To automatically enable the OAuth 2.0 Proof Key for Code Exchange (PKCE) extension, which improves security, select Use Proof Key for Code Exchange (PKCE) Extension. For more information on how this setting helps secure your provider, see Build the PKCE Extension into Your Implementations.
12. Optionally, set these fields.
    • The Token Issuer field identifies the source of the authentication token in the form https://URL.

      For an OAuth 2.0 web server authentication flow, the provider must include an ID token in the response from the token endpoint. Optionally, the provider can include an ID token in the response for a refresh token flow.

      The ID token is validated against the Token Issuer value and information in the UserInfo endpoint. The signature of the ID token isn’t validated.

      The audience for the ID token is the consumer key registered with your authentication provider. Don’t include any other audience values.

    • For Default Scopes, enter the scopes to send along with the request to the authorization endpoint. Otherwise, the hard-coded defaults for the authentication provider type are used. See the OpenID Connect developer documentation for these defaults.

      For Default Scopes, enter the scopes to send along with the request to the authorization endpoint. Otherwise, the hard-coded defaults for the authentication provider type are used. See the OpenID Connect developer documentation for these defaults.

    • If you enter a consumer key and consumer secret, the consumer secret is included in SOAP API responses by default. To hide the secret in SOAP API responses, deselect Include Consumer Secret in SOAP API Responses. Starting in November 2022, the secret is always replaced in Metadata API responses with a placeholder value. On deployment, replace the placeholder with your consumer secret as plain text, or modify the value later through the UI.
13. Optionally, to have the token sent in a header instead of a query string, select Send access token in header.
14. Optionally, to send the consumer key and secret in a Basic header instead of in the request body, select Send client credentials in header.
15. Optionally, set these fields.
    • For Custom Error URL, enter the URL for the provider to use to report any errors.
    • For Custom Logout URL, enter a URL to provide a specific destination for users after they log out, if they authenticated using the SSO flow. Use this field to direct users to a branded logout page or destination other than the default Salesforce logout page. The URL must be fully qualified with an http or https prefix, such as https://acme.my.salesforce.com.
    

    Tip Configure single logout (SLO) to automatically log out a user from Salesforce and the identity provider. As the relying party, Salesforce supports OpenID Connect SLO when the user logs out from the identity provider or Salesforce.
16. To use an Apex registration handler, take these steps.
    1. For Registration Handler Type, select Apex.
    2. For Registration Handler, select an existing Apex class that implements the Auth.RegistrationHandler interface. Or, to create an template for the registration handler, click Automatically create a registration handler template. Edit this class later, and modify the default content before using it.
17. To use a flow for your registration handler, take these steps.
    1. For Registration Handler Type, select Flow.
    2. For Registration Handler, select an existing flow of the Identity User Registration flow type.
    3. Select a default profile. A default profile is required to run the registration handler. If you don't specify a default profile here, set the default profile in the flow itself.

       If you use the Authentication Provider User Registration flow template, the profile that you set here is automatically stored in the defaultProfileId variable.

    4. Select a default account. If you use your authentication provider for Experience Cloud sites, this account stores new internal users.

       If you use the Authentication Provider User Registration flow template, the profile that you set here is automatically stored in the defaultAccountId variable.

18. For Execute Registration As, select an execution user to run the Apex class or flow. The user must have the Manage Users permission.

    Execute Registration As provides the context in which the registration handler runs. In production, you typically create a system user for the Execute Registration As user. This way, operations performed by the handler are easily traced back to the registration process. For example, if a contact is created, the system user creates it.

19. To use a portal with your provider, select the portal from the Portal dropdown list.
20. For Icon URL, add a path to an icon to display as a button on the login page for a site. This icon applies to an Experience Cloud site only. It doesn’t appear on your Salesforce login page or My Domain login URL. Users click the button to log in with the associated authentication provider for the site. Specify a path to your own image, or copy the URL for one of our sample icons into the field.
21. To use the Salesforce multi-factor authentication (MFA) functionality instead of your identity provider’s MFA service, select Use Salesforce MFA for this SSO provider. This setting triggers MFA only for users who have MFA applied to them directly. For more information, see Use Salesforce MFA for SSO.
22. Save the settings.

Update Your OpenID Connect App

Test the SSO Connection

Add the Authentication Provider to Your Login Page