---
title: "SSO.OIDC with Okta"
component: "gui"
version: "4.2"
module: "admin-portal"
html_url: "/gui/4.2/admin-portal/security/sso-oidc-okta"
canonical_url: "https://www.tigergraph.com/docs/gui/4.2/admin-portal/security/sso-oidc-okta"
markdown_url: "https://www.tigergraph.com/docs/gui/4.2/admin-portal/security/sso-oidc-okta.md"
---

[View as HTML](https://www.tigergraph.com/docs/gui/4.2/admin-portal/security/sso-oidc-okta)

# SSO.OIDC with Okta

This guide will show you have to set up a Okta SSO.OIDC connection for TigerGraph.

## 1) Create an Okta Account

1. Create an OIDC application on Okta, here is a guide from step 1 to 10 [How To Set Up Your Own Okta App (OpenID Connect)](https://breadbutter.io/how-to-set-up-okta-openid-connect/)  
   1. Register an account and login Okta.  
   2. Below are some main detail information for settings and then select save.  
   ![Screen Shot 2024 03 05 at 2.35.52 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.35.52%20PM.png)  
   ![Screen Shot 2024 03 05 at 2.37.12 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.37.12%20PM.png)

For the Sign-in and Sign-out redirect URIs the IP(s) can be replaced with your own IP instances.

For example:

Sign-in: <http://your%5Ftigergraph%5Finstances%5FIP:14240/api/auth/oidc/callback>

Sign-out: <http://your%5Ftigergraph%5Finstances%5FIP:14240>

## 2) Configure TigerGraph Backend

1. Set configurations on the TigerGraph backend.  
   1. Check the `GUI.Cookie.SameSite` config (default is `3`)  
   Example:  
   GUI.Cookie.SameSite   Default mode: 1; Lax mode: 2; Strict mode: 3; None mode: 4  
         1. If the SSL instance is enabled, set `GUI.Cookie.SameSite` to `4`.  
         2. If the SSL instance is disabled SSL, set `GUI.Cookie.SameSite` to `3`.  
         3. Set via the command:  
         Example:  
         gadmin config set GUI.Cookie.SameSite 3  
   2. Get Okta configuration using this URL but update `your_okta_app_domain` with your Okta domain:  
   https://your_okta_app_domain/.well-known/openid-configuration  
   Example:  
   https://dev-710975.okta.com/.well-known/openid-configuration  
         1. Login to TigerGraph backend and set the OIDC config entry via the command, you will need two items from your Okta account:  
                  1. Security.SSO.OIDC.OP.ClientId : This is your application `clientId` on Okta, after your created an OIDC app on Okta, you can find it in configuration.  
                  2. Security.SSO.OIDC.OP.ClientSecret : This is your application `clientSecret` on Okta, after your created an OIDC app on Okta, you can find it in configuration.  
         2. Start the configuration process with this command  
         gadmin config entry OIDC  
         Below is a configuration example:  
         tigergraph@oidc-centos7-0:/home/graphsql$ gadmin config entry OIDC  
         Security.SSO.OIDC.Enable [ true ]: Enable OIDC based SSO [true/false]: default false  
         New: true  
         Security.SSO.OIDC.CallBackUrl [ http://your_tigergraph_instances_IP:14240 ]: TigerGraph service provider callback URL: default http://127.0.0.1:14240  
         New: http://your_tigergraph_instances_IP:14240  
         Security.SSO.OIDC.ResponseType [ code ]: Define the kind of credential that OIDC provider will return [code/token/id_token/code id_token/...]: default code  
         New: code  
         Security.SSO.OIDC.Scope [ openid profile ]: Specifies the claims (or user attributes) to retrieve, separated by a space [openid email/openid profile/...]: default openid profile (means user's full profile).  
         New: openid profile email  
         Security.SSO.OIDC.BuiltinUser [ __GSQL__oidc ]: The builtin user for OIDC, default: __GSQL__oidc  
         New: __GSQL__oidc  
         Security.SSO.OIDC.ClaimAsUserID [ email ]: The OIDC claim which will be used as username in TigerGraph, default: email.  
         New: email  
         Security.SSO.OIDC.OrganizationId [  ]: The organization ID for cloud OpenId server, internal use only for TG cloud.  
         New:  
         Security.SSO.OIDC.OP.SSOUrl [ https://login.okta.com/oauth2/v1/authorize ]: Single Sign-On URL: default https://op.example.com/oauth/authorize  
         New: https://login.okta.com/oauth2/v1/authorize  
         Security.SSO.OIDC.OP.Issuer [ https://login.okta.com ]: Entity that issues a set of claims, example: https://example.issuer.tigergraph.com.  
         New: https://login.okta.com  
         Security.SSO.OIDC.OP.AccessTokenURL [ https://your_okta_app_domain/oauth2/v1/token ]: The API to request access token from OP, not needed for OIDC implicit flow, example: https://op.example.com/oauth/token.  
         New: https://your_okta_app_domain/oauth2/v1/token  
         Security.SSO.OIDC.OP.UserInfoURL [ https://your_okta_app_domain/oauth2/v1/userinfo ]: The API to request user information via access token, not needed for OIDC implicit flow, example: https://op.example.com/userinfo.  
         New: https://your_okta_app_domain/oauth2/v1/userinfo  
         Security.SSO.OIDC.OP.ClientId [ 0oae05wqtevYEx0A55d7 ]: The client id assigned by Openid Provider when registers TigerGraph  
         New: 0oae05wqtevYExxxxxxxxxx  
         Security.SSO.OIDC.OP.SigAlgorithm [ RS256 ]: Define the algorithm that OIDC provider used to sign the ID token, [RS256/HS256/...]: default RS256  
         New: RS256  
         Security.SSO.OIDC.OP.ClientSecret [ BUxbeyK0eVpboa7Vdv5kJafgNi4beux1UNUhLPvjbdX1emae8gwtN8oHp3eoKcey ]: The client secret generated by OIDC provider, this config is only needed if algorithm is HMAC type  
         New: BUxbeyK0eVpboa7Vdv5kJafgNi4beux1UNUhLPvjbdX1emae8gwtN8oHxxxxxx  
         Security.SSO.OIDC.OP.JWKSUrl [ https://login.okta.com/oauth2/v1/keys ]: The url of the OpenID provider to retrieve the public JSON web key set, e.g. https://op.example.com/.well-known/jwks.json. It is only needed  if algorithm is RSA type  
         New: https://login.okta.com/oauth2/v1/keys  
         [   Info] Configuration has been changed. Please use 'gadmin config apply' to persist the changes.  
         tigergraph@oidc-centos7-0:/home/graphsql$ gadmin config apply -y

## 3) Setup OIDC Button

After above operations, you will see the login via OIDC button on TigerGraph.

![Screen Shot 2024 03 05 at 2.38.18 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.38.18%20PM.png) 

1. Now, grant a role to a OIDC user on TigerGraph via Admin Portal  
   1. Login to TigerGraph via `superuser` (`tigergraph`)  
   2. Go to **Admin Portal** **Management** **User**  
   3. Click tab: **All Users** **Proxy Group**  
   4. Click **Add Group**  
         1. Type the group name, attribute name and value, name depend on `Security.SSO.OIDC.Scope`.  
         ![Screen Shot 2024 03 05 at 2.38.51 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.38.51%20PM.png)  
         Figure 1\. Type the group name, attribute name and value  
   5. Now, grant a role for the `Proxy Group` and save.  
   ![Screen Shot 2024 03 05 at 2.39.23 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.39.23%20PM.png)  
   Figure 2\. Example

## Login with OIDC

1. Go to TigerGraph login portal, select the **Login with OIDC** button  
![Screen Shot 2024 03 05 at 2.39.58 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.39.58%20PM.png)
2. This will redirect you to the Okta login page.  
![Screen Shot 2024 03 05 at 2.40.25 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.40.25%20PM.png)
3. Lastly, select one account and click. This will redirect you to TigerGraph.  
![Screen Shot 2024 03 05 at 2.41.39 PM](https://www.tigergraph.com/docs/gui/4.2/admin-portal/_images/Screen%20Shot%202024-03-05%20at%202.41.39%20PM.png)
