Skip to content

Commit 25c0005

Browse files
authored
Merge pull request #446 from smallstep/carl/okta-usersync
Okta User sync docs
2 parents b27ee55 + d38b92f commit 25c0005

File tree

2 files changed

+141
-0
lines changed

2 files changed

+141
-0
lines changed

manifest.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,15 @@
7676
]
7777
},
7878
{
79+
"title": "Add Users to Smallstep",
80+
"routes": [
81+
{
82+
"title": "Sync Okta Users (SCIM)",
83+
"path": "/tutorials/sync-okta-users-to-smallstep.mdx"
84+
}
85+
]
86+
},
87+
{
7988
"title": "Smallstep for WPA-Enterprise Wi-Fi",
8089
"routes": [
8190
{
Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
---
2+
updated_at: October 23, 2025
3+
title: Sync Okta Users to Smallstep
4+
description: Smallstep Okta User SCIM synchronization
5+
---
6+
7+
### Prerequisites
8+
9+
You will need:
10+
11+
* An account on the Smallstep platform
12+
Need one? [Register here](https://smallstep.com/signup)
13+
* Okta Super Administrator privileges
14+
* Okta Lifecycle Management Subscription
15+
16+
### Features
17+
18+
The following provisioning features are supported:
19+
20+
* Push Groups and New Users
21+
* New users created through Okta will also be created in Smallstep.
22+
* Push Profile or Group Updates
23+
* Updates made to the user's profile through Okta will be pushed to Smallstep.
24+
* Push User Deactivation
25+
* Deactivating the user or disabling the user's access to the application through Okta will deactivate the user in Smallstep.
26+
* Note: For this application, deactivating a user means removing access to login, but the user's devices will not be affected.
27+
* Reactivate Users
28+
* User accounts can be reactivated in the application.
29+
30+
## Overview
31+
32+
In this quickstart, we will:
33+
34+
1. Create a new OIDC application in Okta, for single sign-on
35+
2. Enter OIDC details into the Smallstep UI
36+
3. Add and configure the Smallstep application from the Okta Application Directory, for user sync via SCIM
37+
4. Confirm users and groups are syncing to Smallstep
38+
39+
## Step By Step Instructions
40+
41+
### **Step 1. Create Okta OIDC Application**
42+
43+
1. Start at your Okta admin dashboard (access via "Admin" button next to "+ Add Apps" after successful log in)
44+
2. Go to Applications → Create App Integration
45+
3. In the pop up select "OIDC - OpenID Connect" as the sign-in method and specify "Native Application" for the Application type.
46+
4. New Native App Integration Page
47+
* App integration name: `smallstep-oidc`
48+
* Sign-in redirect URIs: `http://127.0.0.1:10000`
49+
* Select "Skip group assignment for now"
50+
* All other value leave as default
51+
* **Save**
52+
5. Go to the **General** tab → Scroll down to "Client Credentials" and choose "Edit"
53+
* Select "Use Client Authentication" radio button
54+
* **Save**
55+
6. Go to the **Assignments** tab.
56+
7. Assign any groups that will need access to Smallstep to the `smallstep-oidc` app
57+
8. Go back to **General** tab and scroll down to "Client Credentials." You'll refer to these values in the next step.
58+
59+
### Step 2. Enter your OIDC Details into the Smallstep dashboard
60+
61+
1. Start at [Connect an Okta IdP](https://smallstep.com/app/?next=/settings/users/identity-providers/okta/connect)
62+
2. Copy and paste your **Client ID** and **Client Secret** from Okta.
63+
3. The **Configuration Endpoint** is derived from your Okta domain. Fill your Okta domain into the following URL:
64+
65+
`https://{your Okta domain}/.well-known/openid-configuration`
66+
67+
This is your **Configuration Endpoint**. For example, if you normally sign into Okta at `https://example.okta.com/`, then your configuration endpoint is `https://example.okta.com/.well-known/openid-configuration`
68+
69+
4. Select how you'd like to sync users from Okta.
70+
5. **Save**
71+
6. After saving, you will see a Base URL for SCIM sync, and a SCIM token. Copy these values for the next step.
72+
73+
### Step 3. Add the Smallstep App Integration and Configure User Sync in Okta
74+
75+
1. In the Okta admin console, add the Smallstep application
76+
* Applications → Browse App Catalog
77+
* Search for `Smallstep`
78+
* Select the Smallstep app.
79+
2. Click "Add"
80+
81+
![](/graphics/quickstart/okta-app-add.png)
82+
83+
3. Select "Do not display application icon to users"
84+
4. Select "Do not display application icon in the Okta Mobile App"
85+
5. De-select "Automatically log in when user lands on login page"
86+
6. Choose Next
87+
88+
![](/graphics/quickstart/okta-app-signon.png)
89+
90+
7. Select "Administrator sets username, user sets password"
91+
8. Application username format: "Okta username prefix"
92+
9. Update application username on "Create and update"
93+
10. Done
94+
95+
### Configure Provisioning
96+
97+
Next, we'll turn on SCIM provisioning of users from Okta.
98+
99+
1. Select the "Provisioning" tab
100+
2. Click "Configure API Integration" and select the checkbox next to "**Enable API integration**"
101+
102+
![](/graphics/quickstart/okta-enable-api.png "Enable API")
103+
104+
3. Paste your **Base URL** for SCIM sync and **API Token** (SCIM Token) into Okta Provisioning form.
105+
4. In Okta, choose **Test API Credentials**. After successful verification, choose **Save**.
106+
107+
![](/graphics/quickstart/okta-api-auth.png "API Auth")
108+
109+
5. Reload the provision tab
110+
6. Under Provisioning → Settings → To App, choose **Edit** and enable the following:
111+
* Create Users
112+
* Update User Attributes
113+
* Deactivate Users
114+
7. Save.
115+
8. Configure Assignments:
116+
* Select the **Assignments** tab → Click **Assign****Assign to Groups**
117+
* Search by group → Assign any groups that will use Smallstep
118+
* Group names that contain a `/` are not supported
119+
9. Configure Push Groups:
120+
* Select the **Push Groups** tab → **Push Groups****Find Groups By Name**
121+
* Search for the same groups that will use Smallstep
122+
* Save.
123+
* Repeat for each desired group.
124+
125+
## Confirmation
126+
127+
Back in Smallstep, go to [Users](https://smallstep.com/app/?next=/users).
128+
You should see your Okta users here.
129+
130+
When users are deactivated in Okta, they will be deactivated in Smallstep.
131+
Their devices will remain in Smallstep.
132+

0 commit comments

Comments
 (0)