Add login with an OpenID Connect identity provider


# Add login with an OpenID Connect identity provider

You can add standard OpenID Connect login to your applications using an external OpenID Connect (OIDC) identity provider (IdP) and enable users to log in to your applications while maintaining their accounts in the external identity providers.

Follow this guide to register an OIDC IdP in Asgardeo and add it to the login flow of your application.

# Register Asgardeo in the IdP

You need to register an OpenID Connect application with the external identity provider. Follow the identity provider's documentation to know how to register an OIDC application.

You can use the following URL as the callbackURL of the application.

https://api.asgardeo.io/t/<organization_name>/commonauth
1

Once you register an application, you will receive the following:

  • client_id (also known as app_id or application_id)
  • client_secret (also known as app_secret)

Check the documentation of the OIDC identity provider and get the following endpoints:

  • Authorization Endpoint URL
  • Token Endpoint URL
  • User Info endpoint (optional)
  • Logout endpoint (optional)

# Register the OIDC IdP

Now, let's register the OIDC IdP in Asgardeo.

  1. On the Asgardeo console, click Develop > Connections.

  2. Click New Connections and select Standard-Based IdP.

  3. Provide a unique identity provider name, select OpenID Connect, and click Next.

    Create OIDC Enterprise IDP in Asgardeo
  4. Enter the following details of the external OIDC identity provider and click Next:

    Parameter Description
    Client ID The client ID obtained from the external identity provider.
    Client secret The client secret obtained from the external identity provider.
    Authorization endpoint URL The authorization endpoint of the external identity provider.
    Token endpoint URL The token endpoint of the external identity provider.
  5. (Optional) Provide the mode of certificate configuration.

    You can either configure a JWKS endpoint or upload a certificate of the external party. This helps to validate the signature of the assertions sent by the external identity provider.

    • JWKS endpoint: The JWKS endpoint of the external identity provider.
    • Use PEM certificate : Upload or paste the public certificate of the external identity provider. The certificate should be in PEM format.
      If you have certificate in other formats such as `.crt`, `.cer` or `.der`, expand here to see how you can convert them to PEM format using OpenSSL

      Convert CRT to PEM

      openssl x509 -in cert.crt -out cert.pem
      
      1

      Convert CER to PEM:

      openssl x509 -in cert.cer -out cert.pem
      
      1

      Convert DER to PEM:

      openssl x509 -in cert.der -out cert.pem
      
      1
  6. Click Finish to complete the registration.

Once the OIDC identity provider is created, you can configure additional OIDC settings from the Protocol tab.

Asgardeo requests for the openid scope from the external identity provider. If you need more attributes from the external identity provider, you can configure scope as an additional query param. For example, you can configure the key as scope and the value as openid profile (i.e, scope=openid profile).

# Enable the OIDC IdP for login

Before you begin

You need to have an application registered in Asgardeo. If you don't already have one, register one of the following application types:

  1. On the Asgardeo console, click Develop > Applications.

  2. Open your application from the list and go to the Sign-in Method tab.

  3. If you haven't already defined a sign-in flow, click Start with Default configuration to get started.

  4. Click Add Authentication on the step, select your OIDC identity provider, and click Add.

    Add OIDC identity provider login in Asgardeo

# How it works

To provide this login capability, Asgardeo uses the standard OpenID Connect with authorization code flow underneath. For an application, this flow works as follows:

Add OIDC enterprise login in Asgardeo