# SSO

Currently Dashworks supports Google SSO, Microsoft Azure SSO, and Okta SSO.  If you would like to request additional providers, please reach out to <support@dashworks.ai>.

{% tabs %}
{% tab title="Okta" %}

### The first steps should be taken within the Okta Admin Panel:

1. Go to **Applications** under **Applications**

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/9vGAUvfQMi2sYqGIjJtT/Screenshot%202021-12-20%20at%208.12.43%20PM.png" alt=""><figcaption></figcaption></figure>

2. On the Applications page, select **Browse App Catalog**

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/88EJHh1DgXXQbSW69lkL/Screenshot%202021-12-20%20at%208.12.57%20PM.png" alt=""><figcaption></figcaption></figure>

3. Search for **Dashworks** App and add it

<figure><img src="https://426524836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F48ZJSsUfoeTy0eGVWSPU%2Fuploads%2F6xVDor7uqxLUZyrvCwPu%2FScreenshot%202023-12-19%20at%2011.50.06%E2%80%AFAM.png?alt=media&#x26;token=e752ecaf-dd4f-49a4-8721-e3f5287e74f5" alt=""><figcaption></figcaption></figure>

4. Add an Application label and click **Done**

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/fvMc6rn2xrYcFsRr42sa/Screenshot%202021-12-20%20at%208.24.21%20PM.png" alt=""><figcaption></figcaption></figure>

5. User must specify the Initiate Login URI in the sign-on settings.  In most cases this will be [https://apigw.dashworks.ai/v1/google/auth-url?origin=web.dashworks.ai](https://api.dashworks.ai/v1/google/auth-url?origin=web.dashworks.ai). For on-prem deployment, please contact [**support@dashworks.ai**](mailto:support@dashworks.ai) for the Initiate Login URI.

<figure><img src="https://426524836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F48ZJSsUfoeTy0eGVWSPU%2Fuploads%2FucYWlbZVQ5uKNKIjJEv8%2FScreenshot%202024-09-26%20at%204.21.54%E2%80%AFPM.png?alt=media&#x26;token=d92fda15-5d0d-4f37-8066-86a3bb4118c1" alt=""><figcaption></figcaption></figure>

6. Once the App is added, you will have to assign users to the app under the **Assignments** tab. This will enable to users to log into Dashworks app using Okta. To add users, navigate to the **Assign to People** option under **Assign** option on **Assignments** Page. If you already have a group you can choose the **Assign to Groups** option and assign the entire group.

<figure><img src="https://426524836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F48ZJSsUfoeTy0eGVWSPU%2Fuploads%2F9Sn8EWmFumyrWr8RfCw4%2FScreenshot%202023-12-19%20at%2011.53.15%E2%80%AFAM.png?alt=media&#x26;token=b36f38b9-e9fe-4240-b783-ec12055f4c62" alt=""><figcaption></figcaption></figure>

7. You can add people by clicking the **Assign** option next to their name. After you have all the people click the **Done** button

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/FnSxLFvqwreoZDSNOJlT/Screenshot%202021-12-20%20at%208.33.27%20PM.png" alt=""><figcaption></figcaption></figure>

Note: Make sure all the user profiles have these fields populated:&#x20;

* **Username**
* **First Name,**
* **Last Name**
* **Primary Email**
* **Display Name.**

These fields are required to create profiles in Dashworks. Below is a sample user profile with all required attributes.

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/vY551g8GuQWcxR0kMqSz/Screenshot%202022-01-05%20at%208.36.24%20PM.png" alt=""><figcaption></figcaption></figure>

### **Now you're ready to open the Dashworks App:**

1. Log into Dashworks and navigate to Settings -> Security under Workspace settings. Click on **Configure** next to OIDC.

   <figure><img src="https://426524836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F48ZJSsUfoeTy0eGVWSPU%2Fuploads%2FG6OA6fxy47WrqGrp5E2N%2FScreenshot%202023-12-19%20at%2011.33.01%E2%80%AFAM.png?alt=media&#x26;token=45f1761f-1760-4248-9030-b8c2685b57b7" alt="" width="242"><figcaption></figcaption></figure>
2. You will require **Client ID, Client Secret, and Issuer URL**

<figure><img src="https://426524836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F48ZJSsUfoeTy0eGVWSPU%2Fuploads%2FO5SGbGqHRDha1WtFWtDn%2FScreenshot%202023-12-19%20at%2011.55.07%E2%80%AFAM.png?alt=media&#x26;token=6e19823d-df30-4734-bbc6-0c3b5e1b5b82" alt=""><figcaption></figcaption></figure>

**Issuer URL** will be of the format <https://your-company.okta.com> for example [*https://dashworks.okta.com*](https://dashworks.okta.com). You can get this from the Okta browser tab.

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/4wgAljBKQyuBNqLUPDsL/Screenshot%202021-12-20%20at%209.05.24%20PM.png" alt=""><figcaption></figcaption></figure>

Also if URL has **-admin** suffix for example <https://your-company-admin.okta.com>, just remove the suffix and only use <https://your-company.okta.com> (**https\://** is required).

3. Fill in the Client ID, Client Secret, and Issuer URL and click **Submit**

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/D2rklmiEbU6u4cyRd2w8/Screenshot%202021-12-20%20at%209.09.12%20PM.png" alt=""><figcaption></figcaption></figure>

4. On successfully applying the changes, you should see the following message:

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/CrF4xHSeFcJJjBiReB81/Screenshot%202021-12-20%20at%209.20.51%20PM.png" alt=""><figcaption></figcaption></figure>

{% endtab %}

{% tab title="Azure AD" %}

### The first steps should be taken within the Azure Portal.

1. Go to *Azure portal* > *Azure Active Directory*
2. In your Active Directory, click **+Add** option and then click App registration

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/eQMiV1UfSzuth7KXMbs2/Screenshot%202022-01-18%20at%203.32.52%20PM.png" alt=""><figcaption></figcaption></figure>

3. In the app registration form, give a unique name to your application and keep the default option for Supported account types. For Redirect URI, please set Redirect type as **WEB** and value as <https://dashworks.auth.us-west-2.amazoncognito.com/oauth2/idpresponse>

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/8UdM5wMztxre0bKcobCV/Screenshot%202022-01-18%20at%203.38.48%20PM.png" alt=""><figcaption></figcaption></figure>

4. Click on Register and the application will be created. Save the Client ID and Tenant ID (highlighted below) for the newly created app, **this will be required in the SSO creation process on Dashworks app**

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/cSlTQZsZMPqitzgdmTXX/Screenshot%202022-01-18%20at%203.40.10%20PM.png" alt=""><figcaption></figcaption></figure>

5. On the left window, select Certificates and Secrets to create a client secret

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/Rk1OHUZChVdn1TjlkcCY/Screenshot%202022-01-18%20at%203.43.49%20PM.png" alt=""><figcaption></figcaption></figure>

6. Click on **+New Client Secret and** fill in the relevant details in the client secret form.&#x20;

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/SWlhtQWOj6emJLqUmTsW/Screenshot%202023-02-08%20at%203.15.10%20PM.png" alt=""><figcaption></figcaption></figure>

Recommended expires value is 24 months, to avoid creating the SSO registration again for 24 months. Add the secret key after filling in the details in the form.

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/cX1UnjmgBv4OFUjQdWk5/Screenshot%202022-01-18%20at%203.47.42%20PM.png" alt=""><figcaption></figcaption></figure>

7. Copy the **Value** of the newly created secret key, **this will be required in the SSO creation process on Dashworks app**

### **Now you're ready to open the Dashworks App:**

1. Navigate to Settings --> Security in the navigation bar.&#x20;

<figure><img src="https://426524836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F48ZJSsUfoeTy0eGVWSPU%2Fuploads%2FIU5uuUWoXYcPVZJEV2sq%2FScreenshot%202024-03-07%20at%205.30.59%E2%80%AFPM.png?alt=media&#x26;token=33888777-bc3d-4169-b53c-7e566d58622f" alt=""><figcaption></figcaption></figure>

2. Input the information below and configure the SSO
3. **Client Id**: Noted in Step 4 above&#x20;
4. **Client Secret:** Noted in Step 7 above&#x20;
5. **Issuer Url:** [**https://login.microsoftonline.com/**](https://login.microsoftonline.com/)**\<tenant\_id>/v2.0,** replace \<tenant\_id> with your org tenant id noted in Step 4 above.
6. Sign out of Dashworks, then click "Sign in with SSO" to sign in with Azure AD.
   {% endtab %}

{% tab title="Google" %}

Google SSO does not require additional setup. You can simply select Google as your SSO provider in the “Single sign-on” page within Dashworks.

If you have a Google Workspace you will be prompted with Google SSO both when you first create an account:

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/wkqsy1ROxzxNxqIfJZnU/Screenshot%202023-02-08%20at%203.08.05%20PM.png" alt=""><figcaption></figcaption></figure>

You will also be prompted to use SSO if you are logging back in after logging out:

<figure><img src="https://content.gitbook.com/content/48ZJSsUfoeTy0eGVWSPU/blobs/4j3m5OP2KX5qW0vH3ZnN/Screenshot%202023-02-08%20at%203.08.16%20PM.png" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}
