Select a site

IMPORTANT: This version of Sitefinity CMS is out of support and the respective product documentation is no longer maintained and can be outdated. Use the version selector to view a supported product version.

For developers: Configure custom external OpenID Connect provider

The OpenID Connect protocol supports multiple authentication flows. You can configure external providers, such as Facebook or Google, out-of-the-box. For more information, see Administration: Configure external identity providers. You can also configure a custom external identity provider. 

The following article demonstrates the minimum configuration required to successfully authenticate the user in Sitefinity CMS STS, using Implicit flow. You first register the provider in Sitefinity CMS backend and, then, implement the provider.

Register custom external identity provider

 To do this, perform the following:
  1. Navigate to Administration » Settings » Advanced.
  2. In the left pane, expand Authentication » SecurityTokenService » AuthenticationProviders.
  3. Click Create new » AuthenticationProviderElement.
  4. Enter the Name and the Title of the provider.
    In this example, enter CustomSTS
  5. Select Enabled checkbox.
  6. Save your changes.
    The provider is created.
    If required, you can configure additional parameters of the provider, instead of hard coding them.
  7. Under the newly created provider, expand Parameters and create the following parameters:
    Key Value 
    clientId  The client ID configured in the external STS. 
    issuer  The absolute path to the external STS.
    redirectUri  The absolute path to the local STS.

    NOTE: Make sure the path is added in the external STS during client registration. The path, configured in the external STS, must be identical to the value of the redirectUri parameter.
    responseType Set the value to "id_token"
    scope  Set the value to "openid profile rememberMe email"
    caption  The text that is displayed on the login button.
  8. Save your changes.

Implement the external identity provider

You implement and configure the custom external authentication provider. You create a custom AuthenticationProvidersInitializer where you configure the external provider and then register the initializer in the ObjectFactory. 

Once a user logs via SSO with the STS in the relying party instance, in case there is no user previously authenticated with the same email, a new local user account is automatically created. The profile fields of the account are populated with the information provided by the STS in the claims that are returned. Profile fields of the local account (in the relying party instance) are updated only when they are empty and only from the claims received by the STS. Thus, if you edit your first name in the relying party instance, the change is not synced with the first name on the STS. Once the account is created locally, it is bound to the identity authenticated via email by the STS. If the email is modified either in the STS, or in the local profile in the relying party instance, a new account is once again created for the external user when they log in. If this is the case, all local profile information and local application roles are lost.

Use the following sample:

 

Back To Top

Next: Best practices: Authentication