Skip to content

Commit d1ea750

Browse files
docs: add sso okta + jumpcloud configurations (#340)
Co-authored-by: lukqw <lukqw@users.noreply.github.com>
1 parent 9c787ec commit d1ea750

File tree

8 files changed

+157
-0
lines changed

8 files changed

+157
-0
lines changed
246 KB
Loading
240 KB
Loading
774 KB
Loading
1010 KB
Loading
345 KB
Loading
277 KB
Loading
68.7 KB
Loading

src/content/docs/aws/enterprise/sso/index.md

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,163 @@ Select **Enable IdP sign out flow** if you want your users to be logged out from
3636

3737
![Configuring SSO using SAML](/images/aws/saml-sso.png)
3838

39+
40+
## Configuring SSO with Okta
41+
42+
This section provides a reference configuration for setting up SAML-based SSO with **Okta**.
43+
44+
The steps below mirror the fields required in the LocalStack UI and can be used as a template when configuring your Okta application.
45+
46+
### 1. Create a SAML 2.0 App in Okta
47+
48+
In your Okta Admin Dashboard, create a new application under:
49+
50+
> **Applications → Create App Integration → SAML 2.0**
51+
52+
During setup, Okta will ask for:
53+
54+
* **Single sign-on URL**
55+
* **Audience URI (SP Entity ID)**
56+
57+
You can copy these values directly from your LocalStack SSO provider creation screen.
58+
59+
Example mapping:
60+
61+
| LocalStack name | Okta field name |
62+
| ---------------------- | --------------------------- |
63+
| Callback URL | Single sign-on URL |
64+
| Identifier (Entity Id) | Audience URI (SP Entity ID) |
65+
66+
67+
### 2. Configure SAML Attribute Statements
68+
69+
LocalStack supports mapping the following user attributes:
70+
71+
* **email**
72+
* **firstName**
73+
* **lastName**
74+
75+
In Okta, add these under **Attribute Statements (optional)**:
76+
77+
| Name | Name format | Value |
78+
| --------- | ----------- | ---------------- |
79+
| email | Unspecified | `user.email` |
80+
| firstName | Unspecified | `user.firstName` |
81+
| lastName | Unspecified | `user.lastName` |
82+
83+
> **Note:** In some setups, Okta may not always populate `firstName` or `lastName` during signup. This is usually a configuration mismatch on the IdP side. Users can still manually enter these fields during signup if needed.
84+
85+
![Configuring SSO using Okta with SAML Attribute Statements](/images/aws/sso-okta-attribute-statements.png)
86+
87+
![Configuring SSO using Okta with SAML Attribute Statements](/images/aws/sso-okta-attribute-statements-2.png)
88+
89+
### 3. Retrieve the Okta Metadata URL
90+
91+
Once the application is created, navigate to:
92+
93+
> **Applications → Sign On → SAML 2.0 → Metadata URL**
94+
95+
Copy this URL.
96+
97+
![Retrieve Okta Metadata URL](/images/aws/retrieve-okta-metadata-url.png)
98+
99+
This URL should be used in the LocalStack UI under:
100+
101+
> **Metadata File → URL**
102+
103+
LocalStack will automatically import the SAML metadata and map the endpoints required for SSO.
104+
105+
### 4. Configure LocalStack Identity Provider
106+
107+
In the LocalStack SSO configuration screen:
108+
109+
* Select **Provider type: SAML**
110+
* Enter an **Identity provider name** (e.g., “Okta”)
111+
* Paste the **Metadata URL** from Okta
112+
* Fill in attribute mappings:
113+
114+
| Your attributes (from Okta) | LocalStack attributes |
115+
| --------------------------- | --------------------- |
116+
| email | Email |
117+
| firstName | First Name |
118+
| lastName | Last Name |
119+
120+
Once completed, LocalStack will display:
121+
122+
* **Callback URL**
123+
* **Identifier (Entity Id)**
124+
* **Sign Up Portal URL**
125+
126+
These values are used in the Okta app configuration and for distributing the signup link to end-users.
127+
128+
![Place Okta Metadata URL in LocalStack UI](/images/aws/import-metadata-file.png)
129+
130+
### 5. Assign Users to the Okta Application
131+
132+
Ensure that the correct users and groups have access to the Okta SAML app. Only assigned users will be able to authenticate into LocalStack via SSO.
133+
134+
135+
136+
## SSO for JumpCloud
137+
138+
This example outlines the required configuration when using **JumpCloud** as a SAML Identity Provider for LocalStack.
139+
140+
### 1. Create a Custom SAML Application
141+
142+
In the JumpCloud Admin Portal:
143+
144+
1. Go to **SSO Applications → Add New Application**
145+
2. Select **Custom Application**
146+
3. Open **Manage Single Sign-On (SSO)** and choose **Configure SSO with SAML**
147+
148+
![JumpCloud Admin Portal Custom Application](/images/aws/jumpcloud-step1.jpg)
149+
150+
151+
### 2. Map Required Fields
152+
153+
Copy the fields from the LocalStack SSO configuration screen into the corresponding JumpCloud fields.
154+
155+
| JumpCloud field | LocalStack value |
156+
| ----------------- | ---------------------- |
157+
| **IdP Entity ID** | Identity provider name |
158+
| **SP Entity ID** | Identifier (Entity Id) |
159+
| **ACS URLs** | Callback URL |
160+
| **Login URL** | Sign Up Portal |
161+
162+
![JumpCloud Map Required Fields](/images/aws/jumpcloud-step2.png)
163+
164+
165+
### 3. Attribute Mapping
166+
167+
Add the following user attributes:
168+
169+
| Service Provider Attribute | JumpCloud Attribute |
170+
| -------------------------- | ------------------- |
171+
| email | email |
172+
| firstname | firstname |
173+
| lastname | lastname |
174+
175+
176+
### 4. Required Options
177+
178+
Ensure the following options are enabled:
179+
180+
* **Declare Redirect Endpoint**
181+
* **Include Group Attribute** with the name:
182+
183+
```
184+
memberOf
185+
```
186+
187+
![JumpCloud Map Required Fields](/images/aws/jumpcloud-step4.png)
188+
189+
190+
### 5. Assign Users
191+
192+
Save the application and assign users or groups who should access LocalStack via SSO.
193+
194+
195+
39196
## Attribute mapping
40197

41198
These attributes can be defined to automatically map attributes of user entities in your internal IdP to user attributes in the LocalStack platform.

0 commit comments

Comments
 (0)