|
| 1 | += Managing authentication with OIDC using IAMv2 [.badge.badge-early-access]#Early Access# |
| 2 | +endif::[] |
| 3 | +:last_updated: 12/2/2024 |
| 4 | +:linkattrs: |
| 5 | +:experimental: |
| 6 | +:page-layout: default-cloud |
| 7 | +:description: Learn how to integrate with OIDC for authentication. |
| 8 | + |
| 9 | + |
| 10 | +ThoughtSpot integrates with OpenID Connect (OIDC) for authentication. |
| 11 | + |
| 12 | +== OIDC SSO authentication |
| 13 | + |
| 14 | +ThoughtSpot supports the Single Sign-On (SSO) authentication method with the OpenID Connect (OIDC) authentication. |
| 15 | +With OIDC, users can authenticate to the identity provider (IdP) at your organization to access the ThoughtSpot application, or the embedded ThoughtSpot content in an external web application. |
| 16 | +It also allows them to navigate seamlessly between different application interfaces with their existing credentials. |
| 17 | + |
| 18 | +By default, xref:authentication-local.adoc[local authentication] is enabled. After you configure OIDC authentication, you can configure the ThoughtSpot login page to default to SSO login by contacting {support-url}. Note that if you change the default login experience to SSO, local users cannot authenticate. |
| 19 | + |
| 20 | +Use this article to learn how to configure an OIDC integration with an external IdP. |
| 21 | + |
| 22 | +=== OIDC authentication with multiple IdPs |
| 23 | + |
| 24 | +You may have multiple groups of users who need to # to ThoughtSpot but are managed by separate IdPs. |
| 25 | +You can configure SAML SSO login for more than one Identity Provider. |
| 26 | +To configure this, contact {support-url}. |
| 27 | + |
| 28 | +== About OIDC authentication |
| 29 | + |
| 30 | +OIDC authentication involves several entities and components. |
| 31 | + |
| 32 | +=== OIDC entities |
| 33 | + |
| 34 | +OIDC is an json standard that allows secure exchange of user authentication and authorization data between trusted partners. |
| 35 | +It enables the following entities to exchange identity, authentication, and authorization information: |
| 36 | + |
| 37 | +* *Identity Provider (IdP)* |
| 38 | ++ |
| 39 | +The Identity Management system that maintains the user identity information. |
| 40 | +IdP acts as an authority and authenticates SSO users. |
| 41 | +ThoughtSpot supports OIDC authentication framework with popular Identity Providers such as Google, Amazon, and Microsoft. This is not an exhaustive list. |
| 42 | +To determine if ThoughtSpot supports your preferred IdP, talk to your ThoughtSpot contact. |
| 43 | ++ |
| 44 | +After you complete the configuration in ThoughtSpot that this article describes, refer to your Identity Provider's documentation for specific information on setting up authentications with that IdP. |
| 45 | + |
| 46 | +* *Service Provider (SP)* |
| 47 | ++ |
| 48 | +The provider of a business function or application service; |
| 49 | +for example ThoughtSpot. |
| 50 | +The SP relies on the IdP to authenticate users before allowing access to its services. |
| 51 | + |
| 52 | +* *Federated user* |
| 53 | ++ |
| 54 | +A user whose identity information is managed by the IdP. |
| 55 | +The federated users have SSO credentials and authenticate to IdP to access various application services. |
| 56 | + |
| 57 | +== Enable OIDC authentication |
| 58 | + |
| 59 | +You need admin privileges to enable OIDC authentication. |
| 60 | + |
| 61 | +. Configure the ThoughtSpot application instance on your IdP server. |
| 62 | +.. For the *Single sign on URL* and the *Audience URI* in your IdP provider, you must enter dummy values. You return to these fields in step 15, after completing OIDC configuration in ThoughtSpot. |
| 63 | +.. Make a note of the names you use when you map your IdP's version of the `mail` and `username` attributes. You must use these names to map the email and username attribute in ThoughtSpot later. The `display name` attribute is optional; if you would like to map it as well, make a note of the name you use. |
| 64 | +. # to your ThoughtSpot application instance. |
| 65 | +. From the top navigation bar, select the *Admin* tab. |
| 66 | +. Expand *Authentication* and select *Identity Providers* from the side navigation bar. |
| 67 | +. Click the *+ Add Identity Provider* button. |
| 68 | +. Select the tile that corresponds to your identity provider. The available options are *Google IdP*, *Microsoft IdP*, or *Amazon IdP*. If you are connecting to another OIDC IdP, select the *OIDC IdP* tile. |
| 69 | ++ |
| 70 | +image::oicd_idp.png[Select your IdP] |
| 71 | + |
| 72 | ++ |
| 73 | + |
| 74 | +. Under *Specify identity provider details*, fill in the following parameters: |
| 75 | + |
| 76 | +Connection name:: Provide a name for the configuration of the connection to your identity provider. This appears as the connection name on the Admin Console. |
| 77 | +Client Secret:: Enter the Client Secret associated with the Client ID for secure communication. |
| 78 | +Client Id:: Enter the Client ID provided by the OIDC IdP when you registered your application. |
| 79 | +Scopes:: Define the OAuth 2.0 scopes required for authentication and authorization. Separate multiple scopes with spaces. |
| 80 | + |
| 81 | ++ |
| 82 | +The following fields only appear if you selected *OIDC IdP* in Step 6: |
| 83 | + |
| 84 | +Authorization Endpoint:: URL where users authenticate and grant permissions to access protected resources. |
| 85 | +Token Endpoint:: URL where authorization codes are exchanged for access tokens and ID tokens. |
| 86 | +Issuer:: Typically represented as a URL, that issues identity tokens and validates user authentication. |
| 87 | +User Info Endpoint:: URL for retrieving additional user information after authentication, providing user details. |
| 88 | +Jwks Endpoint:: URL for obtaining a JSON Web Key Set, used to verify the authenticity of tokens issued by the IdP. |
| 89 | + |
| 90 | +. Enable JIT user creation to automatically create user accounts if they don't exist in the system during authentication, by toggling on *Auto create user (JIT)*. |
| 91 | +. Click *Continue*. |
| 92 | +. Under *Map attributes*, map the following *ThoughtSpot user attribute* to the corresponding identity provider's *OIDC attribute* assertion: |
| 93 | +Username:: Map the ThoughtSpot username to the corresponding username from the IdP. |
| 94 | +Email:: Map the email to the email associated with the user in the IdP. |
| 95 | +Display name:: Enter the display name. |
| 96 | +roles:: Enter the roles associated with the user. |
| 97 | ++ |
| 98 | +. Click *Save and continue*. |
| 99 | + |
| 100 | +. Under *Add ThoughtSpot to your identity provider*, collect the information required to add the ThoughtSpot application to your IDP. The *Callback URI* is required to add the ThoughtSpot application to your IdP. |
| 101 | +.. To copy and paste the *Callback URI* directly from this page, select the *copy* icons next to the parameter, and paste the information into a separate document. |
| 102 | +. Click *Enable* to enable the connection immediately, or *Later* to complete the configuration without enabling the connection. |
| 103 | +Your IdP is now configured in ThoughtSpot. You must also add the ThoughtSpot application to your IdP. |
| 104 | + |
| 105 | +=== Configure the IdP |
| 106 | + |
| 107 | +To enable the IdP to recognize your host application and ThoughtSpot as a valid service provider, you must configure the IdP with required attributes and metadata. |
| 108 | + |
| 109 | + |
0 commit comments