Skip to content

Commit 17b4141

Browse files
Update Configure and Connect SSO docs
1 parent befd9b0 commit 17b4141

File tree

13 files changed

+278
-286
lines changed

13 files changed

+278
-286
lines changed

content/manuals/admin/organization/insights.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Insights
77
> [!NOTE]
88
> Insights requires a [Docker Business
99
> subscription](/subscription/core-subscription/details/#docker-business) and
10-
> administrators must [enforce sign-in](/security/for-admins/enforce-sign-in/)
10+
> administrators must [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md)
1111
> to ensure that users sign in with an account associated with their
1212
> organization.
1313
@@ -64,7 +64,7 @@ The chart contains the following data.
6464
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
6565
| Total active users | The number of users that have actively used Docker Desktop and either signed in with a Docker account that has a license in your organization or signed in to a Docker account with an email address from a domain associated with your organization. <br><br>Users who don’t sign in to an account associated with your organization are not represented in the data. To ensure users sign in with an account associated with your organization, you can [enforce sign-in](/security/for-admins/enforce-sign-in/). |
6666
| Active with license | The number of users that have actively used Docker Desktop and have signed in to a Docker account with a license in your organization. |
67-
| Active without license | The number of users that have actively used Docker Desktop, are linked to a Docker account with an email address from a domain associated with your organization, and don’t have a license assigned to their account. <br><br>Users without a license don’t receive the benefits of your subscription. You can use [domain audit](/security/for-admins/domain-audit/) to identify users without a license. You can also use [Just-in-Time provisioning](/security/for-admins/provisioning/just-in-time/) or [SCIM](/security/for-admins/provisioning/scim/) to help automatically provision users with a license. Note that when SSO is configured and [enforced](/security/for-admins/single-sign-on/connect/#optional-enforce-sso), active without license will be 0. |
67+
| Active without license | The number of users that have actively used Docker Desktop, are linked to a Docker account with an email address from a domain associated with your organization, and don’t have a license assigned to their account. <br><br>Users without a license don’t receive the benefits of your subscription. You can use [domain audit](/security/for-admins/domain-audit/) to identify users without a license. You can also use [Just-in-Time provisioning](/security/for-admins/provisioning/just-in-time/) or [SCIM](/security/for-admins/provisioning/scim/) to help automatically provision users with a license. Note that when SSO is configured and enforced, active without license will be 0. |
6868
| Users opted out of analytics | The number of users that are a member of your organization that have opted out of sending analytics. <br><br>When users opt out of sending analytics, you won't see any of their data in Insights. To ensure that the data includes all users, you can use [Settings Management](/desktop/hardened-desktop/settings-management/) to set `analyticsEnabled` for all your users. |
6969
| Active users (graph) | The view over time for total active users. |
7070

content/manuals/admin/organization/onboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ To add a member, invite a user and assign them the member role. For more details
6767
Configuring SSO and SCIM is optional and only available to Docker Business subscribers. To upgrade a Docker Team subscription to a Docker Business subscription, see [Upgrade your subscription](/subscription/upgrade/).
6868

6969
You can manage your members in your identity provider and automatically provision them to your Docker organization with SSO and SCIM. See the following for more details.
70-
- [Configure SSO](/security/for-admins/single-sign-on/) to authenticate and add members when they sign in to Docker through your identity provider.
71-
- Optional: [Enforce SSO](/security/for-admins/single-sign-on/connect/#optional-enforce-sso) to ensure that when users sign in to Docker, they must use SSO.
70+
- [Configure SSO](/manuals/security/for-admins/single-sign-on/configure.md) to authenticate and add members when they sign in to Docker through your identity provider.
71+
- Optional: [Enforce SSO](/manuals/security/for-admins/single-sign-on/connect.md) to ensure that when users sign in to Docker, they must use SSO.
7272
> [!NOTE]
7373
>
7474
> Enforcing single sign-on (SSO) and [Step 5: Enforce sign-in for Docker

content/manuals/security/faqs/single-sign-on/domain-faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can do it one time to add the domain to a connection. If your organization e
1818

1919
### Is adding domain required to configure SSO? What domains should I be adding? And how do I add it?
2020

21-
Adding and verifying a domain is required to enable and enforce SSO. See [Step one: Add and verify your domain](/security/for-admins/single-sign-on/configure/#step-one-add-and-verify-your-domain) to learn how to specify the email domains that are allowed to authenticate through your server. This should include all email domains users will use to access Docker. Public domains, for example `gmail.com` or `outlook.com`, are not permitted. Also, the email domain should be set as the primary email.
21+
Adding and verifying a domain is required to enable and enforce SSO. See [Configure single sign-on](/manuals/security/for-admins/single-sign-on/configure.md) for more information. This should include all email domains users will use to access Docker. Public domains, for example `gmail.com` or `outlook.com`, are not permitted. Also, the email domain should be set as the primary email.
2222

2323
### Is IdP-initiated authentication supported?
2424

content/manuals/security/faqs/single-sign-on/idp-faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ No. You can only configure Docker SSO to work with a single IdP. A domain can on
1414

1515
### Is it possible to change my identity provider after configuring SSO?
1616

17-
Yes. You must delete your existing IdP configuration in your Docker SSO connection and then [configure SSO using your new IdP](/security/for-admins/single-sign-on/configure/configure-idp/). If you had already turned on enforcement, you should turn off enforcement before updating the provider SSO connection.
17+
Yes. You must delete your existing IdP configuration in your Docker SSO connection and then [configure SSO using your new IdP](/manuals/security/for-admins/single-sign-on/connect.md). If you had already turned on enforcement, you should turn off enforcement before updating the provider SSO connection.
1818

1919
### What information do I need from my identity provider to configure SSO?
2020

content/manuals/security/for-admins/enforce-sign-in/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ following occurs:
3939

4040
## Enforcing sign-in versus enforcing single sign-on (SSO)
4141

42-
[Enforcing
43-
SSO](/security/for-admins/single-sign-on/connect#optional-enforce-sso) and
42+
[Enforcing SSO](/manuals/security/for-admins/single-sign-on/connect.md) and
4443
enforcing sign-in are different features. The following table provides a
4544
description and benefits when using each feature.
4645

content/manuals/security/for-admins/provisioning/scim.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ For additional details about supported attributes and SCIM, see [Docker Hub API
3636

3737
> [!IMPORTANT]
3838
>
39-
> SSO uses Just-in-Time (JIT) provisioning by default. If you [enable SCIM](scim.md#set-up-scim), JIT values still overwrite the attribute values set by SCIM provisioning whenever users log in. To avoid conflicts, make sure your JIT values match your SCIM values. For more information, see [SSO attributes](../single-sign-on/configure/configure-idp.md#sso-attributes).
39+
> SSO uses Just-in-Time (JIT) provisioning by default. If you [enable SCIM](scim.md#set-up-scim), JIT values still overwrite the attribute values set by SCIM provisioning whenever users log in. To avoid conflicts, make sure your JIT values match your SCIM values. For more information, see
4040
4141
> [!TIP]
4242
>

content/manuals/security/for-admins/single-sign-on/_index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ weight: 10
1212

1313
Single sign-on (SSO) lets users access Docker by authenticating using their identity providers (IdPs). SSO is available for a whole company, and all associated organizations within that company, or an individual organization that has a Docker Business subscription. To upgrade your existing account to a Docker Business subscription, see [Upgrade your subscription](/subscription/upgrade/).
1414

15-
## How it works
15+
## How SSO works
1616

1717
When you enable SSO, Docker supports a IdP-initiated SSO flow for user login. Instead of users authenticating using their Docker username and password, they are redirected to your identity provider's authentication page to sign in. Users must sign in to Docker Hub or Docker Desktop to initiate the SSO authentication process.
1818

@@ -23,27 +23,27 @@ The following diagram shows how SSO operates and is managed in Docker Hub and Do
2323
## How to set it up
2424

2525
SSO is configured using the following steps:
26-
1. Configure SSO by creating and verifying a domain in Docker.
27-
2. Create your SSO connection in Docker and your IdP.
26+
1. [Configure SSO](../single-sign-on/configure.md) by creating and verifying a domain in Docker.
27+
2. [Create your SSO connection](../single-sign-on/connect.md) in Docker and your IdP.
2828
3. Cross-connect Docker and your IdP.
2929
4. Test your connection.
3030
5. Provision users.
31-
6. Optional. Enforce sign-in.
32-
7. Manage your SSO configuration.
31+
6. Optional. [Enforce sign-in](../enforce-sign-in/_index.md).
32+
7. [Manage your SSO configuration](../single-sign-on/manage.md).
3333

3434
Once your SSO configuration is complete, a first-time user can sign in to Docker Hub or Docker Desktop using their company's domain email address. Once they sign in, they are added to your company, assigned to an organization, and if necessary, assigned to a team.
3535

3636
## Prerequisites
3737

3838
Before configuring SSO, ensure you meet the following prerequisites:
39-
* To ensure users are aware of the sign in change, you must first notify your company about the new SSO login procedures.
40-
* Verify that your members have Docker Desktop version 4.4.2 or later installed on their machines.
41-
* If your organization is planning to [enforce SSO](/security/for-admins/single-sign-on/connect/#optional-enforce-sso), members using the Docker CLI are required to [create a Personal Access Token (PAT)](/docker-hub/access-tokens/) to sign in. The PAT will be used instead of their username and password. Docker plans to deprecate signing in to the CLI with a password in the future, so using a PAT will be required to prevent issues with authentication. For more details see the [security announcement](/security/security-announcements/#deprecation-of-password-logins-on-cli-when-sso-enforced).
39+
* Notify your company about the new SSO sign in procedures.
40+
* Verify that all users have Docker Desktop version 4.4.2 or later installed.
41+
* If your organization is planning to [enforce SSO](../enforce-sign-in/_index.md), members using the Docker CLI are required to [create a Personal Access Token (PAT)](/docker-hub/access-tokens/). The PAT will be used instead of their username and password. Docker plans to deprecate signing in to the CLI with a password in the future, so using a PAT will be required to prevent issues with authentication. For more details see the [security announcement](/security/security-announcements/#deprecation-of-password-logins-on-cli-when-sso-enforced).
4242
* Ensure all your Docker users have a valid user on your IdP with the same email address as their Unique Primary Identifier (UPN).
4343
* Confirm that all CI/CD pipelines have replaced their passwords with PATs.
4444
* For your service accounts, add your additional domains or enable it in your IdP.
4545

4646
## What's next?
4747

48-
- Start [configuring SSO](configure/_index.md) in Docker
49-
- Explore the [FAQs](../../../security/faqs/single-sign-on/faqs.md)
48+
- Start [configuring SSO](../../for-admins/single-sign-on/configure.md) in Docker
49+
- Explore the [FAQs](../../../security/faqs/single-sign-on/_index.md)
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
description: Learn how to configure single sign-on for your organization or company.
3+
keywords: configure, sso, docker hub, hub, docker admin, admin, security
4+
title: Configure single sign-on
5+
linkTitle: Configure
6+
aliases:
7+
- /docker-hub/domains/
8+
- /docker-hub/sso-connection/
9+
- /docker-hub/enforcing-sso/
10+
- /single-sign-on/configure/
11+
- /admin/company/settings/sso-configuration/
12+
- /admin/organization/security-settings/sso-configuration/
13+
---
14+
15+
Get started creating a single sign-on (SSO) connection for your organization or company. This guide walks through the steps to add and verify the domains your members use to sign in to Docker.
16+
17+
## Step one: Add your domain
18+
19+
{{< tabs >}}
20+
{{< tab name="Admin Console" >}}
21+
22+
{{< include "admin-early-access.md" >}}
23+
24+
1. Sign in to the [Admin Console](https://admin.docker.com/).
25+
2. Select your organization or company from the left-hand drop-down menu. Note that when an organization is part of a company, you must select the company and configure the domain for the organization at the company level.
26+
3. Under **Security and access**, select **Domain management**.
27+
4. Select **Add a domain**.
28+
5. Enter your domain in the text box and select **Add domain**.
29+
6. The pop-up modal will prompt you with steps to verify your domain. Copy the **TXT Record Value**.
30+
31+
{{< /tab >}}
32+
{{< tab name="Docker Hub" >}}
33+
34+
1. Sign in to [Docker Hub](https://hub.docker.com/).
35+
2. Select **Organizations** and then your organization from the list.
36+
3. On your organization page, select **Settings** and then **Security**.
37+
4. Select **Add a domain**.
38+
5. Enter your domain in the text box and select **Add domain**.
39+
6. The pop-up modal will prompt you with steps to verify your domain. Copy the **TXT Record Value**.
40+
41+
{{< /tab >}}
42+
{{< /tabs >}}
43+
44+
## Step two: Verify your domain
45+
46+
Verifying your domain ensures Docker knows you own it. Domain verification is done by adding your Docker TXT Record Value to your domain host. The TXT Record Value proves ownership, which signals the Domain Name System (DNS) to add this record. It can take up to 72 hours for DNS to recognize the change. When the change is reflected in DNS, Docker will automatically check the record to confirm your ownership.
47+
48+
{{< tabs >}}
49+
{{< tab name="Admin Console" >}}
50+
51+
{{< include "admin-early-access.md" >}}
52+
53+
1. Navigate to your domain host, create a new TXT record, and paste the **TXT Record Value** from Docker.
54+
2. TXT record verification can take 72 hours. Once you have waited for TXT record verification, return to the **Domain management** page of the Admin Console and select **Verify** next to your domain name.
55+
56+
{{< /tab >}}
57+
{{< tab name="Docker Hub" >}}
58+
59+
1. Navigate to your domain host, create a new TXT record, and paste the **TXT Record Value** from Docker.
60+
2. TXT Record Verification can take 72 hours. Once you have waited for TXT record verification, return to the **Security** page of Docker Hub and select **Verify** next to your domain name.
61+
62+
{{< /tab >}}
63+
{{< /tabs >}}
64+
65+
Once you have added and verified your domain, you are ready to create an SSO connection between Docker and your identity provider (IdP).
66+
67+
## More resources
68+
69+
The following videos walk through verifying your domain to create your SSO connection in Docker.
70+
71+
- [Video: Verify your domain for SSO with Okta](https://youtu.be/c56YECO4YP4?feature=shared&t=529)
72+
- [Video: Verify your domain for SSO with Azure AD (OIDC)](https://youtu.be/bGquA8qR9jU?feature=shared&t=496)
73+
74+
## What's next?
75+
76+
[Connect Docker and your IdP](../single-sign-on/connect.md).
77+

content/manuals/security/for-admins/single-sign-on/configure/_index.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

0 commit comments

Comments
 (0)