# Enabling Single Sign-On

## Overview

Single Sign On (SSO) delegates authentication to a 3rd party identity provider such as Okta, Google Workspace, or Azure AD. Abbey supports SSO via the use of a standardized authentication protocol, SAML.&#x20;

Abbey currently supports SSO via Google Workspace and Okta, with more providers on the way.&#x20;

## Setup

* [Setup SSO with Google Workspace](#google-workspace)
* [Setup SSO Okta](#okta)
* [Using SSO](#using-single-sign-on)

### Google Workspace

1. Navigate to the SSO Page under <https://app.abbey.io/>

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2F1nMfrk2utqmKOyRyb8BO%2FScreenshot%202023-09-08%20at%204.27.24%20PM.png?alt=media&#x26;token=f758a748-d264-4bf7-b5bb-f8b576703bb5" alt=""><figcaption><p>SSO Connections</p></figcaption></figure>

2. Go to Google Workspaces and navigate to Apps -> Web and mobile apps

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FNEyHzByptHFOSz7wOOBx%2FScreenshot%202023-09-08%20at%204.28.22%20PM.png?alt=media&#x26;token=c75c0b32-fea0-4ed8-8377-7cc6ae3ef193" alt=""><figcaption><p>Web and Mobile Apps</p></figcaption></figure>

3. Click Add app -> Add custom SAML app

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FTOVywdNLn4a53e0hROuB%2FScreenshot%202023-09-08%20at%204.28.32%20PM.png?alt=media&#x26;token=5234c2de-2fd2-4ac9-98db-8c36d14314c5" alt=""><figcaption></figcaption></figure>

4. Enter in basic details about your SAML Application

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2Fy2aNVoRM3HTCmkc5s3O1%2FScreenshot%202023-09-08%20at%204.29.15%20PM.png?alt=media&#x26;token=2d104bac-5d5d-4e26-9526-5c289b33528e" alt=""><figcaption><p>Basic App Info</p></figcaption></figure>

5. Now you'll be presented with a screen in the Google Admin console with Identity Provider information. Use that to create a new SSO connection in Abbey.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FDkRg8IbhzZgtmE65C7Uq%2FScreenshot%202023-09-08%20at%204.32.43%20PM.png?alt=media&#x26;token=cff722d8-5040-4717-9ed3-88fa74ae0615" alt=""><figcaption><p>Identity Provider Metadata</p></figcaption></figure>

6. Click on *New SSO Connection* and fill in the information presented above

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2Fsbmw29lY7Lt15HgLdZzO%2FScreenshot%202023-09-08%20at%204.33.04%20PM.png?alt=media&#x26;token=f99c7909-ee4a-4c39-8c77-a2fe3d415298" alt=""><figcaption><p>New SSO Connection</p></figcaption></figure>

7. Now you'll see your new SSO connection. Click on it to get the URLs needed by Google Workspaces to finish the SSO connection process.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FO9XiSzDA6agdCCMSrgzD%2FScreenshot%202023-09-08%20at%205.01.57%20PM.png?alt=media&#x26;token=aa27238f-3026-4f65-b7ea-aa11427bf372" alt=""><figcaption><p>Connection Created</p></figcaption></figure>

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FUTeaSc56V4XqvQ1O00ku%2FScreenshot%202023-09-08%20at%205.04.07%20PM.png?alt=media&#x26;token=897917f4-8681-4578-a9be-9913aacad2db" alt=""><figcaption><p>URLs needed by Google Workspace</p></figcaption></figure>

8. Copy over those values into the next screen for the Google Workspace setup

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2F14mnz1NnwxRsbfrZ2TdO%2FScreenshot%202023-09-08%20at%205.04.36%20PM.png?alt=media&#x26;token=71a3a33e-f50c-49c4-a8ff-60bac470fbce" alt=""><figcaption><p>Service Provider Details</p></figcaption></figure>

9. Finish the wizard

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FFy2tIfmk6qdbyGa4S6vi%2FScreenshot%202023-09-08%20at%205.04.52%20PM.png?alt=media&#x26;token=ee6fbcb0-3f32-4b9b-bdff-0608bf93c56f" alt=""><figcaption><p>Finish the wizard</p></figcaption></figure>

10. Grant permission to users who you want to grant Abbey access to the permission to use the new SAML app you created

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2Fu1O9Wu1Wd1otAhY3fYcz%2FScreenshot%202023-09-08%20at%205.05.27%20PM.png?alt=media&#x26;token=d87d6eeb-c8a3-4011-9ad1-bf009bb28566" alt=""><figcaption><p>Example of turning Abbey on for everyone</p></figcaption></figure>

11. Click the *Activate* slider to activate the SAML Connection. Confirm in the modal.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FNZKBreZPjBStt8EcimoY%2FScreenshot%202023-09-08%20at%205.02.13%20PM.png?alt=media&#x26;token=292be98d-5a9c-449e-9f34-b27b1224bc99" alt=""><figcaption></figcaption></figure>

###

### Okta

1. Navigate to the SSO page

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2F1nMfrk2utqmKOyRyb8BO%2FScreenshot%202023-09-08%20at%204.27.24%20PM.png?alt=media&#x26;token=f758a748-d264-4bf7-b5bb-f8b576703bb5" alt=""><figcaption><p>SSO Connections</p></figcaption></figure>

2. Create a new SSO Connection but do not fill in the IDP SSO URL, IDP Entity ID, and IDP Certificate fields

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FxFO9aPyTPUiZCACS2v0y%2FScreenshot%202023-09-25%20at%205.37.08%20PM.png?alt=media&#x26;token=59a256aa-8673-4bec-b994-441d6fa4e91b" alt=""><figcaption><p>New SAML SSO Connection</p></figcaption></figure>

3. Once you create the connection, click on it to find metadata associated with the SAML SSO Connection

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FNAeq9t8QVSTpdEglAxAe%2FScreenshot%202023-09-25%20at%205.37.37%20PM.png?alt=media&#x26;token=dfda39a8-bad0-4337-b78e-c77d471758f6" alt=""><figcaption><p>SSO SAML Connection Details</p></figcaption></figure>

4. Navigate to the Applications screen underneath the Applications sidebar entry

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2F4ADM6zA277rDzUR7EiMw%2FScreenshot%202023-09-25%20at%201.47.09%20PM.png?alt=media&#x26;token=d3656f5c-281c-4008-9cc0-b8bc270ba954" alt=""><figcaption><p>Applications -> Applications</p></figcaption></figure>

5. Click Create App Integration and select SAML 2.0 for the app integration type

<div><figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FAwHqtlVeSd93oYkSBg7J%2FScreenshot%202023-09-25%20at%201.47.35%20PM.png?alt=media&#x26;token=707a2eed-d96a-4cc3-826a-311519c3fe17" alt=""><figcaption><p>Create App Integration</p></figcaption></figure> <figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FEC7KsjEe68jY4bFlrBLp%2FScreenshot%202023-09-25%20at%201.47.48%20PM.png?alt=media&#x26;token=11ffe305-4bdf-4fc4-bfc7-af765baad654" alt=""><figcaption><p>SAML 2.0 Integration Type</p></figcaption></figure></div>

6. Give your SAML Integration App a name and click Next

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2F5hdpUZCRFeFywettViSS%2FScreenshot%202023-09-25%20at%201.48.03%20PM.png?alt=media&#x26;token=a9252a11-f332-4b9e-9c1a-4a65405837a8" alt=""><figcaption><p>SAML Integration General Settings</p></figcaption></figure>

7. Copy/paste the values shown in the Abbey SSO SAML Connections Screen into this Okta screen. The ACS Provider URL corresponds to the Single sign-on URL in Okta and the SP Entity ID corresponds to the Audience URI (SP Entity ID) field in Okta. Hit Next.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FU9udUodzCfDNbkOEJbWM%2FScreenshot%202023-09-25%20at%202.11.17%20PM.png?alt=media&#x26;token=85d1bd6f-3ac8-4e2f-a41a-4313064bba1f" alt=""><figcaption><p>Fill in general SAML Settings Values</p></figcaption></figure>

8. Click the radio button for "I'm an Okta customer adding an internal app" and fill in the other fields as you see fit. Then finish the process. This completes the Okta end of the setup.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FMfjqtt3Q7f3TdKdGRwCp%2FScreenshot%202023-09-25%20at%202.11.41%20PM.png?alt=media&#x26;token=2b29daab-83b1-4b21-9f5a-3b7448b6bb76" alt=""><figcaption><p>Okta Support Information</p></figcaption></figure>

9. Go to your Applications and click on the new Application you just created. Click on the Sign On tab. Scroll down under the SAML 2.0 section until you see the "Show Details" text. Click it to see relevant SAML details that you will need to copy/paste into Abbey to complete the Abbey side of the SAML connection.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FFoWHYwAvTi1PABTO46pr%2FScreenshot%202023-09-25%20at%205.36.05%20PM.png?alt=media&#x26;token=be02e5aa-ffc2-4142-9df3-8ea7470dd54c" alt=""><figcaption><p>Application Sign On Tab</p></figcaption></figure>

###

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FuYLEGclMcya1DFJwoKjY%2FScreenshot%202023-09-25%20at%205.36.15%20PM.png?alt=media&#x26;token=4654a1eb-ff64-429f-9279-0f35730abf96" alt=""><figcaption><p>Show Details for Application</p></figcaption></figure>

10. Copy the Sign on URL field into the Abbey IDP SSO URL field, copy the Issuer URL into the Abbey IDP Entity ID field and copy the Signing Certificate into the IDP Certificate field. Then hit Update.

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FDRw9X2VzvRDIKPiWYwIR%2FScreenshot%202023-09-25%20at%205.38.27%20PM.png?alt=media&#x26;token=fb9b949c-b7da-4b54-a544-b2ec5dd7c862" alt=""><figcaption><p>Finish Abbey SAML Connection Details</p></figcaption></figure>

11. Once you see your SAML connections, activate your new SAML Connection

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FUjhoJBjCYiCNQ5m5kpFy%2FScreenshot%202023-09-25%20at%205.40.09%20PM.png?alt=media&#x26;token=825a81fc-ca03-41da-9d8b-9d361acd6bc7" alt=""><figcaption><p>Activate your SAML Connection</p></figcaption></figure>

## Using Single Sign On

Simply put the email address associated with your user into the login screen, and Abbey will check to see if you are logged in with your IDP.&#x20;

If the user has an active session, they'll proceed seamlessly. If not, they'll be asked to log in, after which they'll be signed into Abbey.&#x20;

<figure><img src="https://1502779850-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FudoTqG501gLo2MLzBG55%2Fuploads%2FAiPBc0gLPcShwGpcDXck%2FScreenshot%202023-09-08%20at%205.03.02%20PM.png?alt=media&#x26;token=b818d87c-5640-41d7-9e82-8d8887f6a0b6" alt=""><figcaption><p>SSO Login</p></figcaption></figure>
