Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

Use the OIDC Settings window to specify the OIDC credentials for when you want to enable OIDC authentication. Once specified, the credentials take effect for all Desktop Clients and Web Consoles connecting to the same SQL DM Repository.

To set your OIDC credentials in the SQL DM Desktop Client

  1. Access the OIDC Settings window by selecting Image Added > OIDC Settings from the SQL Diagnostic Manager toolbar.
  2. Assign the OpenID
  3. Connect 
  4. Connect Provider. It can be a nickname for your Okta or Entra ID
  5. . (For internal use only)
  6. .
  7. 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/....
  8. Insert your Client ID (unique identifier) for the application registered with the OIDC provider.
  9. Insert your Client Secretsecret credential provided by from the provider.Click on the Image Removed button to make your Client Secret visible.
  10. Info
    Find
  11. here your 
  12. your Okta or Entra ID credentials.
  13. Click on theLoginbutton to initiate the OIDC loginlog in.
    • 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.
      • The Authentication status label displays in the wizard whether the user is Authenticated or Not Authenticated
  14. .Once authenticated, the Required checkbox will be available to change if you want to disable OIDC.
    NoteIf you enable/disable the OIDC, you will enable/disable it for all users of this repository
      • .
  15. Click on the Logout button to logout log out from the current OIDC session. It clears any stored tokens or session data.
    Info
    You can logout log out whenever you want from the same wizard. 
  16. Click OK to save your changes in the Repository and Management Service Settings wizard.
    Tip
    • If the token expires, the next time you login, a new token will be is generated automatically.
    • If the authorized session is revoked by the provider, the Authentication Failed message will showappears, and requiring you will need to authenticate again.

For more information, visit Okta or Entra ID.


Scroll pdf ignore
Newtabfooter
aliasIDERA
urlhttp://www.idera.com
 | 
Newtabfooter
aliasProducts
urlhttps://www.idera.com/productssolutions/sqlserver
 
Newtabfooter
aliasPurchase
urlhttps://www.idera.com/buynow/onlinestore
 | 
Newtabfooter
aliasSupport
urlhttps://idera.secure.force.com/
 | 
Newtabfooter
aliasCommunity
urlhttp://community.idera.com
 
|
 
Newtabfooter
aliasResources
urlhttp://www.idera.com/resourcecentral
 | 
Newtabfooter
aliasAbout Us
urlhttp://www.idera.com/about/aboutus
 
Newtabfooter
aliasLegal
urlhttps://www.idera.com/legal/termsofuse