> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gable.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Single Sign-On (SSO)

{false && (

<> Disable rule for inline HTML, and a couple others </>
)}

{false && <> markdownlint-disable MD001 MD033 </>}

Gable supports SAML 2.0 Single Sign-On (SSO). When SSO is enabled, users authenticate through your identity provider avoiding the need for a separate Gable username and password. A Gable account is provisioned automatically the first time a user logs in via SSO and any previously set password is disabled at that point. Username-and-password access remains available for accounts that do not use SSO such as dedicated service accounts.

## Steps to configure Single Sign-On

To configure SSO, follow the below steps:

### 1. Retrieve your SAML configuration details

In order to create a new SAML 2.0 application in your identity provider, you'll need two pieces of information that are specific to your Gable account:

* **Single Sign-On URL (ACS URL)**: Also known as the Assertion Consumer Service (ACS) URL or SP sign-in URL. This URL tells your identity provider where it should send SAML Response after authenticating a user.
* **Audience URI (SP Entity ID)**: Also known as the Service Provider (SP) Entity ID or Issuer. This is a unique identifier for your instance of Gable.

Navigate to the `Settings->SSO` page in the web console to find the values for your account. Keep the tab open or copy the values for use in later steps.

<img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_saml_details.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=c7d7e5b3f08f54968c79f2ce205c1216" alt="SAML Configuration Details" width="2906" height="520" data-path="docs/assets/sso/sso_saml_details.png" />

### 2. Create a new SAML application in your identity provider

Follow the instructions below for your identity provider.

<Tabs>
  <Tab title="Okta">
    1. Log in to the Okta Admin portal. From the `Applications` page, click `Create App Integration`.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_okta_app_integration_button.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=b9ad827ecb713931cb4c14ed52cfa3a7" alt="Okta SSO App Integration Button" width="1270" height="226" data-path="docs/assets/sso/sso_okta_app_integration_button.png" />

    2. Select `SAML 2.0`.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_okta_app_integration_saml_radio.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=7e297f145a9e096e16983224d9354a8d" alt="Okta SSO App Integration Button" width="1854" height="1062" data-path="docs/assets/sso/sso_okta_app_integration_saml_radio.png" />

    3. Name the app `Gable` and set the logo (you can download the logo [here](../assets/GableLogo.png)).

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_okta_general_settings.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=aebc9c83e0c184cdefe9f537c12cc616" alt="" width="1464" height="1050" data-path="docs/assets/sso/sso_okta_general_settings.png" />

    4. Under the `SAML Settings` section, fill in the form using use the values you retrieved earlier from Gable's `Settings->SSO` page.

       * **Single Sign-On URL**: Use the value from Gable's `Settings->SSO` page
       * **Audience URI (SP Entity ID)**: Use the value from Gable's `Settings->SSO` page
       * **Name ID format**: set to `EmailAddress`
       * **Application username**: set to `Email`
       * **Update application username on**: leave set to `Create and update`

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_okta_saml_settings.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=26c5570012471ccaa12696bcc9cf0501" alt="" width="1448" height="1064" data-path="docs/assets/sso/sso_okta_saml_settings.png" />

    5. Configure the following `Attribute Statements` to ensure email addresses and names are correctly populated in Gable.

       * **`http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`**: `user.email`
       * **`http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`**: `user.firstName`
       * **`http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`**: `user.lastName`

       You can leave the Name Format as `Unspecified` for each.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_okta_saml_attributes.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=ef6cf8bf121b802553f2a9a555f1e523" alt="Okta Saml Attributes" width="1452" height="770" data-path="docs/assets/sso/sso_okta_saml_attributes.png" />

    6. Continue through the `Feedback` prompt to complete creating the app! Once the app is created, navigate to the `Sign On` tab and copy the `Metadata URL` - you'll need this in the next step to configure SSO in Gable.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_okta_metadata_url_focused.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=ae3d79ed4bd9262e199416917638891e" alt="" width="1462" height="1596" data-path="docs/assets/sso/sso_okta_metadata_url_focused.png" />
  </Tab>

  <Tab title="Google Workspace">
    1. Log in to the Google Admin dashboard, select `Apps` from the sidebar menu, and then select `Web and Mobile Apps` from the following list. Next, select `Add app->Add custom SAML app` from the dropdown menu.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_google_add_app.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=3620debb09d67737ab4d8cb3cef8e922" alt="Okta SSO App Integration Button" width="2658" height="868" data-path="docs/assets/sso/sso_google_add_app.png" />

    2. Name the app `Gable` and set the logo (you can download the logo [here](../assets/sso/GableLogo_google.png)).

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_google_app_details.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=87f9366986ad01f6e647e76c9f3072b7" alt="" width="2112" height="1370" data-path="docs/assets/sso/sso_google_app_details.png" />

    3. Download the Idp metadata, you'll need this XML file to configure SSO in Gable. You'll have the option to re-download the file once th application is created, so don't worry if you missed this step.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_google_download_metadata.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=3b68664262cc6e42d0fb3db39330ec49" alt="" width="2104" height="564" data-path="docs/assets/sso/sso_google_download_metadata.png" />

    4. Fill out the `Service provider details` form using the values you retrieved earlier from Gable's `Settings->SSO` page.

       * **ACS URL**: Use the `Single Sign-On URL (ACS URL)` value from Gable's `Settings->SSO` page
       * **Entity ID**: Use the `Audience URI (SP Entity ID)` value from Gable's `Settings->SSO` page
       * **Name ID format**: set to `EMAIL`
       * **Name ID**: set to `Basic Information > Primary email`

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_google_saml_details.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=a7fc1fbd31b7d0fb66daf99f80089788" alt="" width="2072" height="1524" data-path="docs/assets/sso/sso_google_saml_details.png" />

    5. Configure the following `Attribute Statements` to ensure email addresses, and names are correctly populated in Gable.

       * **Primary email**: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress`
       * **First name**: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname`
       * **Last name**: `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname`

       You can leave the Name Format as `Unspecified` for each.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_google_saml_attributes.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=70351488359929ec6ae75df2fdcb9ae8" alt="" width="2076" height="1014" data-path="docs/assets/sso/sso_google_saml_attributes.png" />

    6. You'll need to configure user access before anyone at your company can login to Gable using SSO. Depending on your company policies, you may choose to enable access for everyone, or only select groups.

           <img src="https://mintcdn.com/gable/yTF_sjajzmUvUtbD/docs/assets/sso/sso_google_user_access.png?fit=max&auto=format&n=yTF_sjajzmUvUtbD&q=85&s=3a75266bbca64569ffbacf3a6448658b" alt="" width="1558" height="332" data-path="docs/assets/sso/sso_google_user_access.png" />
  </Tab>

  <Tab title="Other">
    If your identity provider is not listed, you should be able to find their documentation for creating a SAML based application, and please reach out to [support@gable.ai](mailto:support@gable.ai) if you'd like to have your IdP added!

    After completing the SAML app setup, your IdP should provide you with either a metadata URL, or metadata XML file for you to download. The metadata URL or file will be used in the next step to configure SSO in Gable.
  </Tab>
</Tabs>

### 3. Configure SSO In Gable

Using either the metadata URL or file provided by your IdP, configure the SSO integration in Gable.

1. Navigate to the `Settings->SSO` page and in the Enable SSO section, click the `Enable` button.

<img src="https://mintcdn.com/gable/ZZCEhOS6Wj4wttxG/docs/assets/sso/sso_gable_configure_sso.png?fit=max&auto=format&n=ZZCEhOS6Wj4wttxG&q=85&s=224354dd657cda16be0f65716a4d53f0" alt="" width="1870" height="1240" data-path="docs/assets/sso/sso_gable_configure_sso.png" />

2. Enter name for your SSO integration - this name will be what users see when they land at Gable's sign-in portal.

   **Note**: The following strings cannot be used as the integration name as they're reserved words in our identity management platform: `Google`, `SAML`.

   Depending on your identity provider, either enter the metadata URL they provided or upload the metadata file you downloaded when creating the SAML app.

<img src="https://mintcdn.com/gable/ZZCEhOS6Wj4wttxG/docs/assets/sso/sso_gable_configure_sso_form.png?fit=max&auto=format&n=ZZCEhOS6Wj4wttxG&q=85&s=f70386f3067cc2cf33412ff802a6cdb5" alt="" width="1954" height="1174" data-path="docs/assets/sso/sso_gable_configure_sso_form.png" />

3. Once you save the SSO configuration, users will have the option to sign in through your identity provider when they land on Gable's sign-in portal.

<img src="https://mintcdn.com/gable/ZZCEhOS6Wj4wttxG/docs/assets/sso/sso_gable_signin_portal.png?fit=max&auto=format&n=ZZCEhOS6Wj4wttxG&q=85&s=4208e40492e6fb2fb0291708f1faf21a" alt="" width="1400" height="738" data-path="docs/assets/sso/sso_gable_signin_portal.png" />
