Guided Okta SSO Integration
The Teleport Okta SSO integration allows Teleport users to authenticate using Okta as an identity provider. Teleport. The guided enrollment flow for the Okta SSO integration is part of the guided Okta integration. This guide is a companion to the guided Okta SSO integration, showing you how to perform required actions within Okta.
If you do not plan to enroll additional components of the guided Okta integration, you can set up only the Okta SSO integration - called an authentication connector - by following Authentication With Okta as an SSO Provider.
Prerequisites
-
A running Teleport Enterprise cluster. If you want to get started with Teleport, sign up for a free trial or set up a demo environment.
-
The
tctlandtshclients.Installing
tctlandtshclients-
Determine the version of your Teleport cluster. The
tctlandtshclients must be at most one major version behind your Teleport cluster version. Send a GET request to the Proxy Service at/v1/webapi/findand use a JSON query tool to obtain your cluster version. Replace teleport.example.com:443 with the web address of your Teleport Proxy Service:TELEPORT_DOMAIN=teleport.example.com:443TELEPORT_VERSION="$(curl -s https://$TELEPORT_DOMAIN/v1/webapi/find | jq -r '.server_version')" -
Follow the instructions for your platform to install
tctlandtshclients:- Mac
- Windows - Powershell
- Linux
Download the signed macOS .pkg installer for Teleport, which includes the
tctlandtshclients:curl -O https://cdn.teleport.dev/teleport-${TELEPORT_VERSION?}.pkgIn Finder double-click the
pkgfile to begin installation.dangerUsing Homebrew to install Teleport is not supported. The Teleport package in Homebrew is not maintained by Teleport and we can't guarantee its reliability or security.
curl.exe -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-windows-amd64-bin.zipUnzip the archive and move the `tctl` and `tsh` clients to your %PATH%
NOTE: Do not place the `tctl` and `tsh` clients in the System32 directory, as this can cause issues when using WinSCP.
Use %SystemRoot% (C:\Windows) or %USERPROFILE% (C:\Users\<username>) instead.
All of the Teleport binaries in Linux installations include the
tctlandtshclients. For more options (including RPM/DEB packages and downloads for i386/ARM/ARM64) see our installation page.curl -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gztar -xzf teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gzcd teleportsudo ./installTeleport binaries have been copied to /usr/local/bin
-
- To check that you can connect to your Teleport cluster, sign in with
tsh login, then verify that you can runtctlcommands using your current credentials. For example, run the following command, assigning teleport.example.com to the domain name of the Teleport Proxy Service in your cluster and [email protected] to your Teleport username:If you can connect to the cluster and run thetsh login --proxy=teleport.example.com --user=[email protected]tctl statusCluster teleport.example.com
Version 19.0.0-dev
CA pin sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678
tctl statuscommand, you can use your current credentials to run subsequenttctlcommands from your workstation. If you host your own Teleport cluster, you can also runtctlcommands on the computer that hosts the Teleport Auth Service for full permissions. - An Okta organization with admin access.
Step 1/4. Choose an authentication connector
-
Visit the Teleport Web UI and from the left sidebar, navigate to Add New -> Integration.
-
Select the Okta tile.
-
In the Choose Your Auth Connector view, select an existing connector or create a new one by selecting an option from the dropdown menu.
You can inspect an existing connector with the tctl command. Replace okta with the name of your connector.
tctl get saml/okta
If one of your existing connectors is named okta, you won't have the option
to create a new connector. That's because the name of the connector created by
the integration is hardcoded as okta. If you have a connector named okta
and you'd like to use a different one, you'll have to create your connector
manually following Authentication With Okta as an SSO Provider
.
If you are using already configured Okta connector, you can skip Okta app configuration and go to the Next steps section of this guide.
Step 2/4. Create and configure an Okta app
Okta Integration Network support is still in beta. If unsure please proceed with the Custom SAML 2.0 app.
- Okta Integration Network
- Custom SAML 2.0 app (legacy)
Add Teleport app to Okta if it hasn't been added previously:
-
In Okta Console, go to Applications.
-
Click Browse App Catalog.
-
Search for and select Teleport, and then click Add Integration.
-
Complete the fields on the settings page and click Done.
-
Go to the Sign On tab and click Edit on the top-right corner of the tab.
-
Scroll down to the
groupsattribute, then selectMatch regexand type in.*in the input field. -
Scroll down and click Save.
Please note this is a legacy way of setting up the Teleport SSO app. The preferred way is to use Okta Integration Network app.
-
In Okta Console, go to Applications.
-
Click Create App Integration.
-
Select "SAML 2.0" and click Next.
-
Give your app a name, e.g. "Teleport" and optionally upload a logo and click Next.
-
That will bring you to the "Configure SAML" step where you'll have to provide a several values:
-
Single sign on URL:
https://example.teleport.sh/v1/webapi/saml/acs/okta -
Audience URI (SP Entity ID):
https://example.teleport.sh/v1/webapi/saml/acs/okta -
Name ID format
EmailAddress -
Application username
Okta username
-
-
In the same "Configure SAML" setup screen, scroll down to the Group Attribute Statements (optional) section and setup it like so:
- Name:
groups| Name format:Unspecified - Filter:
Matches regex|.*
- Name:
-
Click Next. That will bring you to the "Feedback" step where you can just click Finish.
Step 3/4. Assign user groups
-
In the same Okta Teleport app, go to the Assignments tab and click the Assign dropdown.
-
Select "Assign to Groups" and search for the Okta groups which members will have access to Teleport.
-
Click Assign next to each selected groups and click Done.
Step 4/4. Provide your Okta app metadata to Teleport
-
Go to the Sign On tab and scroll down to "Metadata URL".
-
Copy the Metadata URL using the Copy button below it.
-
Go back to the Teleport Web UI, make sure you are in the Step Two view in the Okta SSO connector enrollment flow, paste the metadata URL and click Continue.
At this point, you have completed the guided flow for the Okta SSO integration. All users assigned to the Okta app are now able to log in to Teleport.
Next steps
After completing the guided enrollment flow for the Okta SSO integration, you can proceed to one of two guided enrollment flows:
To learn more about Okta integration and how to manage it see the Teleport Okta integration overview page.