Skip to main content

Configure OIDC SSO in Virtana Platform

To configure OIDC SSO in Virtana Platform, you simply have to enter the OpenID Connect Metadata URL, Client Id, Client Secret that is viewable in your IdP account. This URL accesses OpenID Connect Metadata files that allow the IdP and service provider (SP) to share configuration information.

About This Task

The domain used in the administrator's email address is the domain that the SSO account is bound to in Virtana Platform. All users with the same domain as the administrator will be redirected to the IdP when they log in.

Prerequisites

  • You must have an Administrator role in Virtana Platform to perform this task.

    Important

    If you have configured a custom subdomain as part of white labeling rebranding of Virtana Platform, you must login using that custom subdomain before configuring SSO.

  • You must have configured a Virtana Platform application in your IdP account and made a note of the OpenID Connect Metadata URL.

  • You must have an administrator role with credentials-based login to Virtana Platform.

Steps

  1. Log in to Virtana Platform, click the Settings sprocket and select Login & Permissions.

    login_and_permission.png
  2. Click Configure SSO.

  3. Select SSO Type as OIDC.

  4. Enter the OpenID Connect Metadata URL, Client ID, Client Secret and click Verify and Save Metadata.

    If the URL is correct, the following Configuration Parameters are displayed from the metadata file:

    • Idp Metadata URL

    • Authorization URL

    • Token URL

    • User Info URL

    • Issuer

    • Client ID

  5. Click Save.

    The SSO Configuration page displays, listing the OIDC SSO you just configured.

  6. Click down arrows (down arrows) to see the configuration information for SSO, including the following:

    • Email Domain

    • SP entity ID

    • IdP Metadata URL

    • Authorization URL

    • Token URL

    • User Info URL

    • Issuer

    • Client ID

  7. [Optional] Click Edit if you need to modify any parameters.

    Important

    Do not modify OpenID Connect Metadata URL, Client ID, and Client Secret unless these details from your IdP changes. If you are changing identity providers, be sure to configure the appropriate settings for Virtana Platform in the new IdP.