SSO Login Services
Once Devtron is installed, it has a built-in admin
user with super admin privileges with unrestricted access to all Devtron resources. We recommended to use a user with super admin privileges for initial and global configurations only and then switch to local users or configure SSO integration.
Only users with super-admin privileges can create SSO configuration. Devtron uses Dex for authenticating a user against the identity provider.
To add/edit SSO configuration, go to the SSO Login Services
section of Global Configurations
.
Supported SSO Providers
Below are the SSO providers which are available in Devtron. Select one of the SSO providers (e.g., GitHub) to configure SSO:
Google GitHub GitLab Microsoft LDAP OpenID Connect OpenShift
Dex implements connectors that target specific identity providers
for each connector configuration. You must have a created account for the corresponding identity provider and registered an app for client key and secret.
Refer the following documents for more detail.
https://dexidp.io/docs/connectors/
https://dexidp.io/docs/connectors/google/
1. Create new SSO Configuration
Make sure that you have a super admin access.
Go to the
Global Configurations
→SSO Login Services
and click anySSO Provider
of your choice.In the
URL
field, enter the valid Devtron applicationURL
where it is hosted.For providing
redirectURI
orcallbackURI
registered with the SSO provider, you can either selectConfiguration
orSample Script
.Provide the
client ID
andclient Secret
of your SSO provider (e.g. If you selectGoogle
as SSO provider, then you must enter$GOOGLE_CLIENT_ID
and$GOOGLE_CLIENT_SECRET
in theclient ID
andclient Secret
respectively.)Select
Save
to create and activate SSO Login Service.
Note:
Only single SSO login configuration can be active at one time. Whenever you create or update any SSO configuration, it will be activated and used by Devtron and previous configurations will be deleted.
Except for the domain substring, URL and redirectURI remains same.
2. Update SSO Configuration
You can change SSO configuration anytime by updating the configuration and click Update
. Note: In case of configuration change, all users will be logged out of Devtron and will have to login again.
3. Configuration Payload
type
: Any platform name such as (Google, GitLab, GitHub etc.)name
: Identity provider platform nameid
: Identity provider platform which is a unique ID in string. (Refer to dexidp.ioconfig
: User can put connector details for this key. Platforms may not have same structure but common configurations areclientID
,clientSecret
,redirectURI
.hostedDomains
: Domains authorized for SSO login.
Next Steps
After configuring an SSO for authentication, you need to add users in Devtron, else your users won't be able to log in via SSO.
In case you have enabled auto-assign permissions in Microsoft or LDAP, relevant permission groups must also exist in Devtron for a successful login.
Last updated