You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/team-management-scim-provisioning.mdx
+81-73Lines changed: 81 additions & 73 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,13 +42,14 @@ Before you configure SCIM, ensure that:
42
42
* Your team has the SAML entitlement enabled.
43
43
* You have a Vendor Service Account token with permissions to manage team members. See [Generate API Tokens](/vendor/replicated-api-tokens).
44
44
* You have administrative access to your identity provider.
45
+
* Your identity provider supports SCIM v2.0.
45
46
46
47
## Configure SCIM
47
48
48
-
You can configure SCIM using identity providers that support SCIM v2.0.
49
-
50
49
### Okta Configuration
51
50
51
+
This section describes how to enable SCIM provisioning for Replicated in Okta. For other identity providers, see [Other Identity Providers](#other-identity-providers) below.
52
+
52
53
#### Step 1: Add Replicated Application
53
54
1. In the Okta Admin Console, go to **Applications > Applications**.
54
55
2. Create a custom SAML 2.0 application.
@@ -92,27 +93,45 @@ If name fields are not provided, users are still created, but might have incompl
92
93
:::
93
94
94
95
#### Step 6: Assign Users
96
+
97
+
:::note
98
+
If your team already has users in Replicated, synchronize them with Okta before you assign users. See [Migrate from Existing User Management](#migrate) below.
99
+
:::
100
+
101
+
To assign users in Okta:
95
102
1. Go to the **Assignments** tab.
96
103
2. Assign users or groups to grant access to Replicated.
97
104
98
105
Users are provisioned to your Replicated team automatically.
99
106
100
-
### Migrate from Existing User Management
107
+
### Other Identity Providers
108
+
109
+
For identity providers other than Okta, you can use the following basic settings to configure SCIM:
110
+
-**SCIM Base URL:**`https://api.replicated.com/vendor/scim/v2`
111
+
-**Authentication Method:** Bearer Token
112
+
-**Bearer Token:** Your Replicated Vendor API token
113
+
-**SCIM Version:** 2.0
114
+
115
+
For more information, see [SCIM API](#scim-api) below.
101
116
102
-
If your team already has users in Replicated before you enable SCIM, you can synchronize the existing users with your identity provider. Before you begin, review the best practices:
117
+
## Migrate from Existing User Management {#migrate}
118
+
119
+
If your team already has users in Replicated before you enable SCIM, you can synchronize the existing users with your identity provider.
120
+
121
+
The following are best practices for migrating from existing user management:
103
122
* Test the environment first.
104
123
* Perform a staged rollout starting with a small group of users.
105
124
* Communicate the migration timeline.
106
125
* Document the current user list and permissions before migration.
107
126
* Monitor for provisioning errors during the first few days.
108
127
109
-
####(Recommended) Automatic User Matching
128
+
### (Recommended) Automatic User Matching
110
129
111
130
To automatically match users:
112
131
113
132
1. Ensure that all existing Replicated users have matching accounts in your identity provider. If email addresses do not match exactly or users exist in other teams, follow the steps in [Manual User Migration](#manual-user-migration) below.
114
133
115
-
1. Configure SCIM as described in [Idenitty Provider Configuration](#identity-provider-configuration) above, but do not assign any users yet.
134
+
1. Configure SCIM as described in [Okta Configuration](#okta-configuration) above, but do not assign any users yet.
116
135
117
136
1. Test with a single user:
118
137
1. Assign one existing user to the Replicated application in your identity provider.
@@ -135,7 +154,7 @@ To automatically match users:
135
154
https://api.replicated.com/vendor/scim/v2/Users
136
155
```
137
156
138
-
####Manual User Migration
157
+
### Manual User Migration
139
158
140
159
If email addresses do not match exactly or users exist in other teams, you can manually sync users instead.
141
160
@@ -162,48 +181,43 @@ To manually migrate users:
162
181
```
163
182
Where `YOUR_TOKEN` is a Replicated Vendor Service Account token scoped to your team with permissions to manage team members. For more information, see [Authentication](#authentication) below.
164
183
165
-
### Generic SCIM Provider Configuration
166
-
167
-
For identity providers that support SCIM v2.0, use the basic settings and attributes described below to integrate with Replicated. For more information, see [SCIM API](#scim-api) below.
184
+
## Test the SCIM Integration
168
185
169
-
#### Basic Settings
186
+
###Test SCIM Endpoints
170
187
171
-
- SCIM Base URL: `https://api.replicated.com/vendor/scim/v2`
172
-
- Authentication Method: Bearer Token
173
-
- Bearer Token: Your Replicated Vendor API token
174
-
- SCIM Version: 2.0
188
+
You can use the following curl commands to manually test SCIM endpoints:
0 commit comments