Skip to content

Commit 4b312ce

Browse files
SSO doc updates (#24129)
This PR updates SSO documentation to address inconsistencies, per tech support's jira ticket. I've made some additional changes as well: - I've removed 4/5ish call outs throughout the doc. Callouts lose effectiveness if you use them often. - I've condensed certain redundant UI steps like "Save", "Finish", "Select X" and created more compound steps. This shortens the procedures and simplifies the ~weight of each substep. - Merged Configure and Connect docs into one. Having 1 doc for two steps when they're necessary for the overall action risks losing users and adding confusion. - I've added Prerequisites from the index page to the actual procedures. Prereqs should always be associated closely with the action users are taking after establishing those pre-requisites. --------- Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
1 parent 2d446e2 commit 4b312ce

12 files changed

Lines changed: 162 additions & 210 deletions

File tree

content/manuals/admin/organization/general-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To edit this information:
2929

3030
After configuring your organization information, you can:
3131

32-
- [Configure single sign-on (SSO)](/manuals/enterprise/security/single-sign-on/configure.md)
32+
- [Configure single sign-on (SSO)](/manuals/enterprise/security/single-sign-on/connect.md)
3333
- [Set up SCIM provisioning](/manuals/enterprise/security/provisioning/scim.md)
3434
- [Manage domains](/manuals/enterprise/security/domain-management.md)
3535
- [Create a company](/manuals/admin/company/new-company.md)

content/manuals/admin/organization/onboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ subscription, see [Change your subscription](/manuals/subscription/change.md).
125125
Use your identity provider (IdP) to manage members and provision them to Docker
126126
automatically via SSO and SCIM. See the following for more details:
127127

128-
- [Configure SSO](/manuals/enterprise/security/single-sign-on/configure.md)
128+
- [Configure SSO](/manuals/enterprise/security/single-sign-on/connect.md)
129129
to authenticate and add members when they sign in to Docker through your
130130
identity provider.
131131
- Optional.

content/manuals/enterprise/security/hardened-desktop/settings-management/compliance-reporting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Desktop settings reporting tracks user compliance with Docker Desktop settings p
1717
Before you can use Docker Desktop settings reporting, make sure you have:
1818

1919
- [Docker Desktop 4.37.1 or later](/manuals/desktop/release-notes.md) installed across your organization
20-
- [A verified domain](/manuals/enterprise/security/single-sign-on/configure.md#step-one-add-and-verify-your-domain)
20+
- [A verified domain](/manuals/enterprise/security/single-sign-on/connect.md)
2121
- [Enforced sign-in](/manuals/enterprise/security/enforce-sign-in/_index.md) for your organization
2222
- A Docker Business subscription
2323
- At least one settings policy configured

content/manuals/enterprise/security/hardened-desktop/settings-management/configure-admin-console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Use the Docker Admin Console to create and manage settings policies for Docker D
1717
Before you begin, make sure you have:
1818

1919
- [Docker Desktop 4.37.1 or later](/manuals/desktop/release-notes.md) installed
20-
- [A verified domain](/manuals/enterprise/security/single-sign-on/configure.md#step-one-add-and-verify-your-domain)
20+
- [A verified domain](/enterprise/security/single-sign-on/connect/#step-1-add-a-domain)
2121
- [Enforced sign-in](/manuals/enterprise/security/enforce-sign-in/_index.md) for your organization
2222
- A Docker Business subscription
2323

content/manuals/enterprise/security/provisioning/scim.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ This value is required in your identity provider when creating custom SCIM attri
227227

228228
### Step one: Set up role mapping in Okta
229229

230-
1. Setup [SSO](../single-sign-on/configure/_index.md) and SCIM first.
230+
1. Setup [SSO](../single-sign-on/connect.md) and SCIM first.
231231
1. In the Okta admin portal, go to **Directory**, select **Profile Editor**,
232232
and then **User (Default)**.
233233
1. Select **Add Attribute** and configure the values for the role, organization,

content/manuals/enterprise/security/single-sign-on/FAQs/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
build:
33
render: never
44
title: FAQs
5+
weight: 40
56
---

content/manuals/enterprise/security/single-sign-on/FAQs/users-faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Yes, you can convert existing users to SSO accounts. Ensure users have:
3333
- Personal access tokens created to replace passwords for CLI access
3434
- CI/CD pipelines updated to use PATs instead of passwords
3535

36-
For detailed instructions, see [Configure single sign-on](/manuals/enterprise/security/single-sign-on/configure.md).
36+
For detailed instructions, see [Configure single sign-on](/manuals/enterprise/security/single-sign-on/connect.md).
3737

3838
## Is Docker SSO fully synced with the IdP?
3939

content/manuals/enterprise/security/single-sign-on/_index.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Docker Hub, Docker Desktop, and your IdP.
3434

3535
To configure SSO in Docker, follow these steps:
3636

37-
1. [Configure your domain](configure.md) by creating and verifying it.
37+
1. [Configure your domain](connect.md) by creating and verifying it.
3838
1. [Create your SSO connection](connect.md) in Docker and your IdP.
3939
1. Link Docker to your identity provider.
4040
1. Test your SSO connection.
@@ -46,18 +46,6 @@ Once configuration is complete, users can sign in to Docker services using
4646
their company email address. After signing in, users are added to your company,
4747
assigned to an organization, and added to a team.
4848

49-
## Prerequisites
50-
51-
Before you begin, make sure the following conditions are met:
52-
53-
- Notify your company about the upcoming SSO sign-in process.
54-
- Ensure all users have Docker Desktop version 4.42 or later installed.
55-
- Confirm that each Docker user has a valid IdP account using the same
56-
email address as their Unique Primary Identifier (UPN).
57-
- If you plan to [enforce SSO](/manuals/enterprise/security/single-sign-on/connect.md#optional-enforce-sso),
58-
users accessing Docker through the CLI must [create a personal access token (PAT)](/docker-hub/access-tokens/). The PAT replaces their username and password for authentication.
59-
- Ensure CI/CD pipelines use PATs or OATs instead of passwords.
60-
6149
> [!IMPORTANT]
6250
>
6351
> Docker plans to deprecate CLI password-based sign-in in future releases.
@@ -66,6 +54,6 @@ Using a PAT ensures continued CLI access. For more information, see the
6654

6755
## Next steps
6856

69-
- Start [configuring SSO](configure.md).
57+
- Start [configuring SSO](connect.md).
7058
- Read the [FAQs](/manuals/enterprise/security/single-sign-on/faqs/general.md).
7159
- [Troubleshoot](/manuals/enterprise/troubleshoot/troubleshoot-sso.md) SSO issues.

content/manuals/enterprise/security/single-sign-on/configure.md

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

0 commit comments

Comments
 (0)