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

# Single Sign-On (SSO)

> Configure Single Sign-On (SSO) for user authentication.

<div />

<Info>
  Single Sign-On (SSO) is available for with the teams add-on. See [pricing](https://www.propeldata.com/pricing) or [talk to sales](mailto:sales@propeldata.com) for more details.
</Info>

## Okta configuration

This guide covers configuring your Okta identity provider with Propel for single sign-on to Propel Console.

<Steps>
  <Step title="Create a new app integration">
    Once you've logged into the Okta Admin console, you will need to create a new app:

    1. Navigate to **"Applications"** → **"Applications"**
    2. Click the button **"Create App Integration"**

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/okta/create-new-app.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=8defbdbe92f8eb585175143825a75f9a" alt="A screenshot showing how to create a new app integration in Okta." width="1054" height="536" data-path="images/okta/create-new-app.png" />
    </Frame>
  </Step>

  <Step title="Create a new SAML App Integration">
    Choose **"SAML 2.0"** as the sign-on method:

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/okta/create-app-integration-saml.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=f552536f12937bc2987df72caf281f87" alt="A screenshot showing the selection of SAML 2.0 as the sign-on method for a new app integration in Okta." width="1131" height="886" data-path="images/okta/create-app-integration-saml.png" />
    </Frame>
  </Step>

  <Step title="Configure general settings">
    1. Enter "Propel" for the **"App name"**
    2. (Optional) Add the Propel logo by downloading it [here](https://assets.website-files.com/63bd88046a1e930f29e4b697/63f7baf454526f7862d09066_Propel-logo.png)

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/okta/general-settings.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=0b8fc47d60a232c32bbcf031602a518f" alt="A screenshot showing the general settings for creating a new SAML integration in Okta, including app name and logo upload." width="1051" height="607" data-path="images/okta/general-settings.png" />
    </Frame>
  </Step>

  <Step title="Configure SAML settings">
    1. Copy and paste the following value for **"Single sign-on URL"**:
       ```
       https://idp.propeldata.com/saml2/idpresponse
       ```

    2. Copy and paste the following value for **"Audience URI (SP Entity ID)"**:
       ```
       urn:amazon:cognito:sp:us-east-2_xJZCRvbM3
       ```

    3. Add the following values to the **"Attribute Statements (optional)"**:

       | Name  | Name Format | Value            |
       | ----- | ----------- | ---------------- |
       | email | Unspecified | user.email       |
       | name  | Unspecified | user.displayName |

    <Frame>
      <img src="https://mintcdn.com/propeldocs/G8bGSg66eBpnYaHB/images/docs/2024-08-06-okta-configuration-01.png?fit=max&auto=format&n=G8bGSg66eBpnYaHB&q=85&s=178e50943eabd150d40c8f0a8fc3ddfc" alt="A screenshot showing the SAML settings configuration for Propel in Okta, including Single sign-on URL, Audience URI, and Attribute Statements." width="751" height="857" data-path="images/docs/2024-08-06-okta-configuration-01.png" />
    </Frame>
  </Step>

  <Step title="Provide feedback">
    1. Choose "I'm an Okta customer..."
    2. Click the "Contact App vendor" checkbox

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/okta/feedback.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=7ed6e2b322003a924c6d1a8340fe8867" alt="A screenshot showing the feedback section when creating a new SAML app integration in Okta." width="1040" height="1026" data-path="images/okta/feedback.png" />
    </Frame>
  </Step>

  <Step title="Copy Metadata URL">
    <Warning>
      You must copy the Metadata URL and send this to Propel via your shared Slack channel. Failure to do so may result in incomplete SSO configuration.
    </Warning>

    <Frame>
      <img src="https://mintcdn.com/propeldocs/G8bGSg66eBpnYaHB/images/docs/2024-08-06-okta-configuration-02.png?fit=max&auto=format&n=G8bGSg66eBpnYaHB&q=85&s=f534e24649e52609536bcc634a04ef34" alt="A screenshot showing the Metadata URL for the SAML configuration in Okta." width="762" height="691" data-path="images/docs/2024-08-06-okta-configuration-02.png" />
    </Frame>
  </Step>

  <Step title="Create an Okta Bookmark">
    After Propel has received your Metadata URL and completed the necessary configuration:

    1. Customer support will provide a URL for creating an Okta Bookmark
    2. Create a new Okta Bookmark app
    3. Enter the URL provided by customer support

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/okta/bookmark-app.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=c03119ce477eb4da202cfa85325489f3" alt="A screenshot showing how to create a new Okta bookmark app." width="1069" height="566" data-path="images/okta/bookmark-app.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/propeldocs/r8FN1fDId_ZpxHvr/images/okta/add-integration.png?fit=max&auto=format&n=r8FN1fDId_ZpxHvr&q=85&s=8589808dafa96ea200903b9f0eb5827e" alt="A screenshot showing how to add a new app integration in Okta." width="998" height="651" data-path="images/okta/add-integration.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/propeldocs/G8bGSg66eBpnYaHB/images/docs/2024-08-06-okta-configuration-03.png?fit=max&auto=format&n=G8bGSg66eBpnYaHB&q=85&s=63c11029428e52c57c5f8fd25d0ec23c" alt="A screenshot showing the URL configuration for the Okta bookmark app." width="1033" height="656" data-path="images/docs/2024-08-06-okta-configuration-03.png" />
    </Frame>

    <Warning>
      Propel's current authentication provider does not support IdP-initiated SSO.
    </Warning>
  </Step>
</Steps>

## Managing users

Once you have set up SAML with Okta, you'll need to manage user access to Propel. This section covers how to add users, guide them through the login process, and remove access when necessary.

### Adding a user

To add a user you need to:

<Steps>
  <Step title="Add user to Okta app">
    To add a user to the Okta app "Propel":

    * Log in to your Okta admin dashboard.
    * Navigate to the **"Applications"** section.
    * Find and select the **"Propel"** application.
    * Click on the **"Assignments"** tab.
    * Use the **"Assign"** button to add the user to the application.
  </Step>

  <Step title="Guide user to log in">
    To help the user log in to the Propel Console:

    * Provide the user with the Propel Console login URL: [https://console.propeldata.com/login](https://console.propeldata.com/login).
    * Instruct the user to enter their email address associated with their Okta account.
    * The user should then be redirected to Okta for authentication.
    * Upon successful authentication, they will be granted access to the Propel Console.
  </Step>

  <Step title="Verify email address">
    Ensure that the user's email address in Okta matches the one they use to log in to the Propel Console.
  </Step>
</Steps>

### Logging in to the Propel Console

To login to the Propel Console, you need to:

<Steps>
  <Step title="Navigate to Propel Console">
    Navigate to [https://console.propeldata.com/login](https://console.propeldata.com/login).
  </Step>

  <Step title="Enter email address">
    Enter the email address of the user.
  </Step>

  <Step title="Initiate login">
    Click the **"Login"** button.
  </Step>
</Steps>

<Warning>
  When using Okta for authentication with Propel, you must initiate the login process from Propel's login page. Clicking the "Propel" bookmark in the Okta portal will not work. Always navigate directly to [Propel's login page](https://console.propeldata.com/login) to access your account.
</Warning>

### Removing a user

To remove a user's access to Propel, follow these steps:

<Steps>
  <Step title="Remove user from Okta app">
    To remove the user from the Okta app "Propel":

    * Log in to your Okta admin dashboard.
    * Navigate to the **"Applications"** section.
    * Find and select the **"Propel"** application.
    * Click on the **"Assignments"** tab.
    * Locate the user and click **"Unassign"** to remove them from the application.
  </Step>

  <Step title="Remove user from Propel Console">
    To remove the user from the Propel Console:

    * Log in to the [Propel Console](https://console.propeldata.com/).
    * Navigate to the [Users section](https://console.propeldata.com/users/).
    * Find the user you want to remove.
    * Click on the options menu (usually represented by three dots) next to the user's name.
    * Select **"Delete user"** to delete the user from Propel.
  </Step>

  <Step title="Verify access removal">
    To ensure the user's access has been completely removed:

    * Confirm that the user can no longer log in to the Propel Console using their Okta credentials.
    * Check that any active sessions for this user have been terminated.
  </Step>
</Steps>

<Note>
  It's important to perform both steps to ensure complete removal of access. Removing the user from Okta prevents future logins, while removing them from the Propel Console ensures they no longer have an account within Propel's system.
</Note>
