Skip to content

Commit 968158b

Browse files
authored
Merge pull request #19536 from cockroachdb/DOC-13145
Fixes DOC-13145 : Updated configure-cloud-org-sso
2 parents 687f186 + 041f7a7 commit 968158b

File tree

2 files changed

+68
-1
lines changed

2 files changed

+68
-1
lines changed

src/current/cockroachcloud/configure-cloud-org-sso.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,14 @@ You can add a custom authentication method to connect to any IdP that supports [
162162

163163
### OIDC
164164

165+
#### Supported features
166+
167+
* IdP-initiated SSO
168+
* SP-initiated SSO
169+
* Just-In-Time provisioning
170+
171+
#### Configuration steps
172+
165173
To configure a custom OIDC authentication method, you need the following information from your IdP:
166174

167175
- Issuer URL
@@ -193,8 +201,32 @@ These instructions work for Okta. If you use a different IdP, refer to its docum
193201
1. The authentication method has been added but is disabled. To enable it, toggle **Enable**.
194202
1. Optionally, [configure advanced settings](#configure-advanced-settings) for the new authentication method.
195203

204+
#### SP-initiated SSO
205+
1. Navigate to CockroachDB Cloud Console via your organization's vanity URL.
206+
2. Select the appropriate login method which uses OIDC. You will be redirected to your IdP (e.g. Okta).
207+
3. Log in using your IdP credentials.
208+
4. You will then be automatically redirected and logged into your CockroachDB Cloud Console organization.
209+
196210
### SAML
197211

212+
#### Supported features
213+
214+
* IdP-initiated SSO
215+
* SP-initiated SSO
216+
* Just-In-Time provisioning
217+
218+
#### Supported SAML Attributes
219+
220+
CockroachDB Cloud expects the following SAML attribute mappings from your IdP:
221+
222+
| Name | Value |
223+
| --------- | ---------------- |
224+
| email | user.email |
225+
| name | user.displayName |
226+
227+
228+
#### Configuration steps
229+
198230
To configure a custom SAML authentication method, you need the following information from your IdP:
199231

200232
- Sign On URL
@@ -234,6 +266,13 @@ After SAML is configured, your users can sign in to the CockroachDB {{ site.data
234266
- **Service provider-initiated flow**: Users sign in to the CockroachDB {{ site.data.products.cloud }} Console directly, using your custom sign-in URL.
235267
- **Identity provider-initiated flow**: Users sign in to the CockroachDB {{ site.data.products.cloud }} Console from within your IdP (for example, by accessing its tile in Okta).
236268

269+
#### SP-initiated SSO
270+
1. Navigate to CockroachDB Cloud Console via your organization's vanity URL.
271+
2. Select the appropriate login method which uses SAML. You will be redirected to your IdP (e.g. Okta).
272+
3. Log in using your IdP credentials.
273+
4. You will then be automatically redirected and logged into your CockroachDB Cloud Console organization.
274+
275+
237276
## Require SSO
238277

239278
To begin enforcing a requirement to sign in using SSO:

src/current/cockroachcloud/configure-scim-provisioning.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ Okta disables deprovisioned users and does not support deleting them.
3333

3434
<a id="scim-group-push"></a>
3535

36+
### Supported features
37+
38+
* Create users
39+
* Update user attributes
40+
* Deactivate users
41+
* Import users
42+
* Import groups
43+
* Profile sourcing (Management of certain user fields from the IdP)
44+
* Group push
45+
3646
### SCIM Group Push with Okta
3747

3848
User accounts are provisioned in CockroachDB {{ site.data.products.cloud }} based on assignments in the SCIM app integration. Assigning an IAM group to the app integration is equivalent to assigning each of the group's members individually. However, depending on your IdP, assigning a group to the app integration may or may not automatically create a corresponding group in CockroachDB {{ site.data.products.cloud }} or keep its list of members in sync. Additional configuration of your IdP may be required. If you use Okta, you must enable [Group Push](#automate-group-management) to create and link groups in CockroachDB {{ site.data.products.cloud }}.
@@ -69,7 +79,25 @@ The exact steps and requirements for enabling SCIM provisioning depend upon your
6979
- The endpoint to the CockroachDB {{ site.data.products.cloud }} SCIM API, `https://cockroachlabs.cloud/api/scim/v2`.
7080
- The API token of a CockroachDB {{ site.data.products.cloud }} service account with the [**Org Administrator**]({% link cockroachcloud/authorization.md %}#org-administrator) role.
7181

72-
To add SCIM provisioning to a SAML app integration in Okta:
82+
83+
Depending on your setup, you can configure SCIM either via the Okta Integration Network (OIN) for a standardized app or manually for a custom SAML app integration.
84+
85+
### Add SCIM integration using Okta Integration Network (OIN)
86+
87+
1. Log in to Okta Admin Dashboard as an admin user.
88+
1. Click **Applications** > **Browse App Catalog**.
89+
1. Search for **Cockroach Labs** > Click **Add**.
90+
1. Enter an **Application label**.
91+
1. **Entity ID** and **ACS URL** should be "NA".
92+
1. Click **Next** > Click **Done**.
93+
1. Go to **Provisioning** Tab and click **Configure API Integration**.
94+
1. Check **Enable API integration**.
95+
1. Provide <b>API authentication token</b>: the API token for a CockroachDB {{ site.data.products.cloud }} <a href="managing-access.html#create-a-service-account">service account</a> with the <a href="authorization.html#org-administrator"><b>Org Administrator</b></a> role.
96+
1. **Test API Credentials** > Click **Save**.
97+
1. Click **To App**. This tab controls assignment of Okta identities to CockroachDB {{ site.data.products.cloud }}. To allow provisioning and deprovisioning of users, ensure that **Create Users** and **Deactivate Users** are selected, and make any other desired changes.
98+
1. Optionally, click **To Okta**. This tab allows you to import a CockroachDB {{ site.data.products.cloud }} organization's existing users into Okta. This helps to maintain an updated list of IAM users when an organization creates IAM users in a variety of ways. Refer to Okta's documentation about mapping individual fields. Make any desired changes.
99+
100+
### Add SCIM provisioning to a SAML app integration in Okta
73101

74102
1. Log in to Okta Admin Dashboard as an admin user.
75103
1. Click **Applications** and edit the [SAML]({% link cockroachcloud/configure-cloud-org-sso.md %}#saml) app integration for your CockroachDB {{ site.data.products.cloud }} organization.

0 commit comments

Comments
 (0)