Skip to content

Commit 098e3e5

Browse files
Add overview for provisioning users
1 parent 963bcee commit 098e3e5

File tree

1 file changed

+56
-3
lines changed
  • content/manuals/security/for-admins/provisioning

1 file changed

+56
-3
lines changed
Lines changed: 56 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,59 @@
11
---
2-
build:
3-
render: never
4-
title: Provisioning
2+
description: Learn about provisioning users for your SSO configuration.
3+
keywords: provision users, provisioning, JIT, SCIM, group mapping, sso, docker hub, hub, docker admin, admin, security
4+
title: Provision users
5+
linkTitle: Provision
56
weight: 20
67
---
8+
9+
Once you've configured your SSO connection, the next step is to provision users. This process ensures that users can access your organization.
10+
This guide provides an overview of user provisioning and supported provisioning methods.
11+
12+
## What is provisioning?
13+
14+
Provisioning helps manage users by automating tasks like creating, updating, and deactivating users based
15+
on data from your identity provider (IdP). There are three methods for user provisioning, with benefits for
16+
different organization needs:
17+
18+
| Provisioning method | Description | Default setting in Docker | Recommended for |
19+
| --- | --- | --- | --- |
20+
| Just-in-Time (JIT) | Automatically create and provisions user accounts when they first log in via SSO | Enabled by default | Best for organizations who need minimal setup, who have smaller teams, or low-security environments |
21+
| System for Cross-domain Identity Management (SCIM) | Continuously syncs user data between your IdP and Docker, ensuring user attributes remain updated without requiring manual updates | Disabled by default | Best for larger organizations or environments with frequent changes in user information or roles |
22+
| Group mapping | Maps user groups from your IdP to specific roles and permissions within Docker, enabling fine-tuned access control based on group membership | Disabled by default | Best for organizations that require strict access control and for managing users based on their roles and permissions |
23+
24+
## Default provisioning setup
25+
26+
By default, Docker enables JIT provisioning when you configure an SSO connection. With JIT enabled, user accounts are automatically created the first time a user signs in using your SSO flow.
27+
28+
JIT provisioning may not provide the level of control or security some organizations need. In such cases, SCIM or group mapping can be configured to give administrators more control over user access and attributes. Refer to the following guides to learn more about each provisioning method, and for steps to disable JIT if necessary:
29+
- Guide
30+
- Guide
31+
- Guide
32+
33+
## SSO attributes
34+
35+
When a user signs in through SSO, Docker obtains several attributes from your IdP to manage the user's identity and permissions. These attributes include:
36+
- **Email address**: The unique identifier for the user
37+
- **Full name**: The user's complete name
38+
- **Groups**: Optional. Used for group-based access control
39+
- **Docker Org**: Optional. Specifies the organization the user belongs to
40+
- **Docker Team**: Optional. Defines the team the user belongs to within the organization
41+
- **Docker Role**: Optional. Determines the user's permission within Docker
42+
43+
If your organization uses SAML for SSO, Docker retrieves these attributes from the SAML assertion message. Keep in mind that different IdPs may use different names for these attributes. The following reference table outlines possible SAML attributes used by Docker:
44+
45+
| SSO Attribute | SAML Assertion Message Attributes |
46+
| --- | --- |
47+
| Email address | `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"`, `email` |
48+
| Full name | `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name"`, `name`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"`, `"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"` |
49+
| Groups (optional) | `"http://schemas.xmlsoap.org/claims/Group"`, `"http://schemas.microsoft.com/ws/2008/06/identity/claims/groups"`, `Groups`, `groups` |
50+
| Docker Org (optional) | `dockerOrg` |
51+
| Docker Team (optional) | `dockerTeam` |
52+
| Docker Role (optional) | `dockerRole` |
53+
54+
## What's next?
55+
56+
Review the provisioning method guides for steps on configuring provisioning methods:
57+
- [JIT](/manuals/security/for-admins/provisioning/just-in-time.md)
58+
- [SCIM](/manuals/security/for-admins/provisioning/scim.md)
59+
- [Group mapping](/manuals/security/for-admins/provisioning/group-mapping.md)

0 commit comments

Comments
 (0)