Connect to the SQL Diagnostic Manager Repository with the OIDC Authentication Method.
Prerequisites
- Have Okta or Entra ID OIDC provider credentials.
- The OIDC callback URL should be configured as http://localhost:5000/callback/
- In Okta, configure Allowed Callback URLs as http://localhost:5000/callback/
- In Entra ID, configure Redirect URLs as http://localhost:5000/callback/
Setting the OIDC callback URL for SQL DM Desktop
The OIDC callback URL for the Desktop Client is stored in the user.config file. Although it defaults to http://localhost:5000/callback/, the user can change it to any localhost URL, provided the same URL is included in the list of Allowed Callback URLs. Changes take effect after relaunching the application, which is helpful if port 5000 is already in use on a particular machine.
Setting the OIDC callback URL for SQL DM Web Console
Configure the OIDC callback URL for SQLDM Web Console as https://[machine_name]:9295/callback/. The base of the callback URL must be the same as it was shown in the Web Console during the last step of the installer (but https).
Set your OIDC credentials
- Assign the OpenID Connect Provider. It can be a nickname for your Okta or Entra ID. (For internal use only).
- Insert the Authority URL provided by the OIDC provider. It is the endpoint where the authentication process starts, typically in the format of https://login.provider.com/....
- Insert your Client ID (unique identifier) for the application registered with the OIDC provider.
- Insert your Client Secret credential provided by the provider.
- Click on the
button to make your Client Secret visible.
- Click on the Login button to initiate the OIDC login.
- A web browser appears where you have to authenticate against the OIDC provider.
- On valid authentication, a success message appears.
- If the authentication fails, an unsuccessful message appears.
- A web browser appears where you have to authenticate against the OIDC provider.
- The Authentication status label displays in the wizard whether the user is Authenticated or Not Authenticated.
- Once authenticated, the Required checkbox will be available to change if you want to disable OIDC.
If you enable/disable the OIDC, you will enable/disable it for all users of this repository.
- Click on the Logout button to logout from the current OIDC session. It clears any stored tokens or session data.You can logout whenever you want from the same wizard.
- Click OK to save your changes in the Repository and Management Service Settings wizard.
- If the token expires, the next time you login, a new token will be generated automatically.
- If the authorized session is revoked by the provider, the Authentication Failed message will show, and you will need to authenticate again.
For more information, visit Okta or Entra ID.