OpenID Connect (SaaS)

OpenID support in the Sysdig platform allows authentication via your choice of Identity Provider (IdP). This section describes how to integrate and enable OpenID Connect with both Sysdig Monitor and Sysdig Secure.

Instructions in this section are specific to cloud-based (SaaS) Sysdig environments. If you are configuring an on-premises Sysdig environment, refer to OpenID Connect (On-Prem) instead.

Overview

Using OpenID with Sysdig

The Sysdig platform ordinarily maintains its own user database to hold a username and password hash. OpenID instead allows for redirection to your organization’s IdP to validate user credentials and other policies necessary to grant access to Sysdig applications. Upon successful authentication via OpenID, a corresponding user record in the Sysdig platform’s user database is automatically created, though the password that was sent to the IdP is never seen nor stored by the Sysdig platform.

Enable OpenID

1. Know which IdP your company uses and will be configuring

These are the OpenID Providers for which Sysdig has performed detailed interoperability testing and confirmed how to integrate using their standard docs. If your OpenID Provider is not listed (including ones that do not support OpenID Connect Discovery), it may still work with the Sysdig platform. Contact Sysdig Support for help.

Contact Sysdig for the Company Name associated with your account.

Sysdig SaaS URL - On the main Sysdig login page select the OpenID button and enter your company name.
Direct URL - Access the URL directly from a browser:
1. Monitor: <Monitor Region URL>/api/oauth/openid/COMPANY_NAME
2. Secure: <Secure Region URL>/api/oauth/openid/COMPANY_NAME?product=SDS

Replace the <Monitor Region URL> and <Secure Region URL> with a valid URL from SaaS Regions and IP Ranges.

IdP-Initiated Login - Log in from an IdP interface.
The individual IdP integration pages describe how to add Sysdig to the IdP interface. You will need your Company Name on hand.

3. Configure your IdP and collect the resulting configuration attributes

Collect the metadata URL (or XML) and test it. If you intend to configure IdP-initiated login flow, you need the configure the Redirect URI. See Redirect URI.

4. Configure Sysdig

Log in to Sysdig Monitor or Sysdig Secure and configure authentication.
- Log in to Sysdig Monitor Settings (as super admin) and enter the necessary configuration information in the UI. Save and Enable OpenID as your SSO.
- Log in to Sysdig Monitor Settings (as super admin) and enter the necessary configuration information in the UI. Save and Enable OpenID as your SSO.
Repeat the process for the other Sysdig product, if you are using both Monitor and Secure. Enter a separate redirect URI in your IdP for each product; otherwise, the integration processes are the same.

Configure IdP in Sysdig

Choose Your IdP

Select the appropriate IdP link below, and follow the instructions:

Enter OpenID Connection Settings

Log in to Sysdig Monitor or Sysdig Secure as administrator and select Settings from the user menu.
Select Authentication(SSO) > OpenID.
Enter the relevant parameters and click Save Settings.

Connection Setting	Description
Client ID	The unique ID provided by your IdP.
Client Secret	The secret provided by your IdP.
Issuer URL	The URL provided by your IdP. For example: `https://YOUR-ONELOGIN-DOMAIN.onelogin.com/oidc</`. Use the entire domain path for OpenID Connect, including any trailing `/`.
Create user on login	Enable to allow creating users on login. Otherwise only existing users can login. Default: Enabled.
Metadata Discovery	IdP supports Metadata Discovery. Default: Enabled.
Disable username and password login	Prevent users from logging in using username and password (require IdP login).
Toggle Enable OpenID single logout	Flag to enable single logout. See Configure OpenID Single Logout.
Use External ID	Require customer specific `External ID` in `Redirect URI`. See Use External ID in Redirect URI
Group Mapping	Use Group Mapping. See Group Mappings
Group Attribute Name	For use with Group Mapping. See Group Mappings
Additional Scopes*	The additional scopes required for logging in. The mandatory scopes are `openid`, `profile`, and `email`. You do not need to enter these as additional scopes, only any additional scopes beyond these three.

Okta, OneLogin, and Keycloak support metadata auto-discovery; so these settings should be sufficient for these IdPs.

(Optional) Enter OpenID Additional Settings

In some cases, an OpenID IdP may not support metadata auto-discovery, and additional configuration settings must be entered manually.

In this case:

In the OpenID tab, toggle the Metadata Discovery button to off to display additional entries on the page.
Enter the relevant parameters derived from your IdP and click Save.

Connection Setting	Description
Issuer URL	Required parameter. This value is often the same Issuer URL, but can be different for providers that have a separate general domain and user-specific domain For example, general domain: https://openid-connect.onelogin.com/oidc, user-specific domain: https://sysdig-phil-dev.onelogin.com/oidc The URL provided by your IdP. For example, `https://YOUR-ONELOGIN-DOMAIN.onelogin.com/oidc`. Ensure that you use the entire domain path for OpenID Connect, including any trailing `/`.
Authorization Endpoint	Required. Authorization request endpoint.
Token Endpoint	Required. Token exchange endpoint.
JSON Web Key Set Endpoint	Required. The endpoint that contains key credentials for token signature verification.
End session endpoint	Optional. The URL at the IdP to which a Relying Party (RP) can perform a redirect to request that the end user be logged out at the IdP. This option is required if the single-logout toggle is enabled.
Token Auth Method	Authentication method. Supported values: `client_secret_basic` `client_secret_post` (case insensitive)

Select OpenID for SSO

Select OpenID from the Enabled Single Sign-On dropdown.
Click Set Authentication.
Repeat the entire enablement process for Sysdig Monitor or Sysdig Secure, if you want to enable both applications.

Redirect URI

Identify the correct Redirect URI associated with your Sysdig application and region.

Region	App	Sign-In Redirect URIs
us	Monitor	`https://app.sysdigcloud.com/api/oauth/openid/auth`
us	Secure	`https://secure.sysdig.com/api/oauth/openid/secureAuth`
us2	Monitor	`https://us2.app.sysdig.com/api/oauth/openid/auth`
us2	Secure	`https://us2.app.sysdig.com/api/oauth/openid/secureAuth`
us4	Monitor	`https://app.us4.sysdig.com/api/oauth/openid/auth`
us4	Secure	`https://app.us4.sysdig.com/api/oauth/openid/secureAuth`
au1	Monitor	`https://app.au1.sysdig.com/api/oauth/openid/auth`
au1	Secure	`https://app.au1.sysdig.com/api/oauth/openid/secureAuth`
eu1	Monitor	`https://eu1.app.sysdig.com/api/oauth/openid/auth`
eu1	Secure	`https://eu1.app.sysdig.com/api/oauth/openid/secureAuth`
me2	Monitor	`https://app.me2.sysdig.com/api/oauth/openid/auth`
me2	Secure	`https://app.me2.sysdig.com/api/oauth/openid/secureAuth`

For more information on regions, see SaaS Regions and IP Ranges.

Use External ID in Redirect URI

To improve security, Sysdig introduced the option to enable customer-specific (unique, generated), External ID. The ID is automatically generated for each customer and you cannot modify it. External ID is in UUID format - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

When the option to use External ID is enabled, the External ID must appended to the Redirect URI. The format is as follows: <REDIRECT_URI>/<EXTERNAL_ID>. Replace <REDIRECT_URI> with actual Redirect URI and <EXTERNAL_ID> with actual External ID.

See Main Authentication Settings to retrieve your External ID.

The use of External ID is going to be required after July 1st 2024. After this date it won’t be possible to disable the toggle and the toggle will be removed from the UI. It is recommended to switch your IdP to Redirect URI with External ID in your settings as soon as possible.

Configure OpenID Single Logout

With Single Logout (SLO), users only need to sign out of one service provider, and all the active sessions will be terminated without any additional effort. This is vastly convenient from a usability perspective.

SLO Process

Sysdig requests that the IdP logs the end user out by redirecting the user’s User Agent to the IdP’s Logout Endpoint. The IdP’s endpoint can be retrieved via the end_session_endpoint element of the IdP’s Discovery response (metadata). After a logout has been performed, the User Agent associated with the user will be redirected to the Sysdig login page.

Configure IdP

Configure Sign-out redirect URIs:

US East
- Monitor: app.sysdigcloud.com?follow_redirect=false
- Secure: secure.sysdig.com?follow_redirect=false
Other regions
https://<region>.app.sysdig.com?follow_redirect=false
Replace <region> with the region where your Sysdig application is hosted.

Configure Sysdig

Log in to Sysdig Monitor or Sysdig Secure as an administrator.
For on-prem deployments, log in as the super admin.
Navigate to Settings > Authentication(SSO), and select OpenID under Connection Settings.
Enter the OpenID configuration.
Ensure that Enable OpenID single logout is toggled on.
Click Save Settings.
Select OpenID from the Enable Single Sign On drop-down, and click Set Authentication.

As noted in the enablement workflow above, you can offer users three ways to log in with an OpenID configuration:

Sysdig SaaS URL

Users can begin at the Sysdig SaaS URL and click the OpenID button.

See SaaS Regions and IP Ranges and identify the correct SaaS URL associated with your Sysdig application and region. For example, the URLs of Monitor and Secure for US East are:

Monitor: https://app.sysdigcloud.com/

Secure: https://secure.sysdig.com

For other regions, the format is https://<region>.app.sysdig.com. Replace <region> with the region where your Sysdig application is hosted. For example, for Sysdig Monitor in the EU, you use https://eu1.app.sysdig.com.

They will be prompted to enter a Company Name, so the Sysdig platform can redirect the browser to your IdP for authentication.

Direct URL

You can provide an alternative URL to avoid the user having to enter a company name, in the format:

Monitor: <https://app.sysdigcloud.com/api/oauth/openid/>CompanyName
Secure: <https://secure.sysdig.com/api/oauth/openid/>CompanyName?product=SDS

You can configure an IdP-initiated login flow when configuring your IdP. The users then select the Sysdig application from your IdP’s app directory and do not need to browse directly to a Sysdig application URL.

See User and Team Administration for information on creating users.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.