CloudDM 4.8.0 adds GreptimeDB as a DataSource
Skip to main content

OpenID Connect (OIDC) authentication

CloudDM uses an OpenID Connect provider for sign-in and handles DataSource access after authentication.

Configure your organization's OpenID Connect service as a dedicated provider in CloudDM's Integration > SSO settings.

What is OIDC?​

OpenID Connect (OIDC) adds authentication to OAuth 2.0. OIDC verifies who a user is, while OAuth 2.0 defines how a user or application gets permission to access resources.

Organizations can use an identity provider such as Keycloak to let users sign in to CloudDM and other applications with the same account.

How it works​

  1. The user chooses the OIDC option on the CloudDM sign-in page. The browser redirects to the identity provider.
  2. After sign-in, the provider redirects the browser to CloudDM with an authorization code.
  3. CloudDM exchanges the code with the provider, retrieves the user's information, and completes sign-in.

Configure OIDC​

  1. Sign in with an account that can manage integrations.
  2. Open Integration > SSO and click New.
  3. Select OIDC. To edit an existing provider, use Settings for that provider in the list.
  4. Fill in the settings and click Add.
SettingRequiredDescription
Well-Known URLYesURL of the provider's OpenID Connect discovery document.
Client IDYesIdentifier of the OIDC client.
Client SecretYesSecret for the OIDC client. The edit form hides the saved secret.
ScopeYesRequested scopes, such as openid email profile.
Default roleNoRole assigned when an OIDC user first signs in to CloudDM.

Verify sign-in​

  1. Sign out and open the CloudDM sign-in page.
  2. Choose the OIDC option and complete sign-in with the identity provider.
  3. Confirm that the browser returns to CloudDM and that the user's profile and role match the configuration.

Identity provider examples​

Keycloak​

  1. Sign in to the Keycloak Admin Console.
  2. Select a realm, or create a realm.
  3. Create an OpenID Connect client for CloudDM. Copy its client identifier into CloudDM's Client ID field.
  4. Configure redirects and origins.
    • Add the exact CloudDM callback URI to Valid redirect URIs, such as https://clouddm.example.com/callback/auth?provider=OIDC.
    • Set Web origins to the corresponding CloudDM origin.
    • Enable Client authentication to configure the client secret.
  5. Copy the client secret from Keycloak's Credentials tab into Client Secret in CloudDM.
  6. Set Well-Known URL to the realm's discovery document, such as https://keycloak.example.com/realms/<your-realm>/.well-known/openid-configuration.

Google SSO​

Google accounts can sign in to CloudDM through OIDC. For provider details, see the Google OpenID Connect documentation.

  1. Open Google Auth Platform, select or create a project, and configure Branding and Audience. For an app in testing, add the Google accounts you will use to verify sign-in as test users.
  2. Open Clients, click Create client, and choose Web application.
  3. Under Authorized redirect URIs, add the CloudDM callback, such as https://clouddm.example.com/callback/auth?provider=OIDC. The callback must match the redirect_uri in CloudDM's sign-in request exactly.
  4. Create the client and copy its client ID and secret.
  5. Set Well-Known URL in CloudDM to https://accounts.google.com/.well-known/openid-configuration. Enter the Google client ID and secret, set Scope to openid email profile, and choose a default role if needed.
  6. Save the settings, sign out, and verify Google SSO through CloudDM's OIDC sign-in option.
info

Use the identity provider's documentation to check current page and field names.