Skip to content

Commit 11cfa4a

Browse files
fix: update SSO troubleshooting guide w/ toc_max
1 parent 43c344d commit 11cfa4a

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

content/manuals/security/troubleshoot/troubleshoot-sso.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ keywords: sso, troubleshoot, single sign-on
44
title: Troubleshoot single sign-on
55
linkTitle: Troubleshoot SSO
66
tags: [Troubleshooting]
7+
toc_max: 2
78
aliases:
89
- "/security/for-admins/single-sign-on/troubleshoot/"
910
---
@@ -16,15 +17,15 @@ following sections describe some common SSO errors and possible solutions.
1617

1718
If you experience issues with SSO, check both the Docker Admin Console and your identity provider (IdP) for errors first.
1819

19-
#### Check Docker error logs
20+
### Check Docker error logs
2021

2122
1. Sign in to the [Admin Console](https://app.docker.com/admin/) and select your organization.
2223
2. Select **SSO and SCIM**.
2324
3. In the SSO connections table, select the **Action** menu and then **View error logs**.
2425
4. For more details on specific errors, select **View error details** next to an error message.
2526
5. Note any errors you see on this page for further troubleshooting.
2627

27-
#### Check for errors in your IdP
28+
### Check for errors in your IdP
2829

2930
1. Review your IdP’s logs or audit trails for any failed authentication or provisioning attempts.
3031
2. Confirm that your IdP’s SSO settings match the values provided in Docker.
@@ -36,31 +37,31 @@ For further troubleshooting, check your IdP’s documentation. You can also cont
3637

3738
## Groups are not formatted correctly
3839

39-
#### Error message
40+
### Error message
4041

4142
When this issue occurs, the following error message is common:
4243
```text
4344
Some of the groups assigned to the user are not formatted as '<organization name>:<team name>'. Directory groups will be ignored and user will be provisioned into the default organization and team.
4445
```
4546

46-
#### Possible causes
47+
### Possible causes
4748

4849
- Incorrect group name formatting in your identity provider (IdP): Docker requires groups to follow the format `<organization>:<team>`. If the groups assigned to a user do not follow this format, they will be ignored.
4950
- Non-matching groups between IdP and Docker organization: If a group in your IdP does not have a corresponding team in Docker, it will not be recognized, and the user will be placed in the default organization and team.
5051

51-
#### Affected environments
52+
### Affected environments
5253

5354
- Docker single sign-on setup using IdPs such as Okta or Azure AD
5455
- Organizations using group-based role assignments in Docker
5556

56-
#### Steps to replicate
57+
### Steps to replicate
5758

5859
To replicate this issue:
5960
1. Attempt to sign in to Docker using SSO.
6061
2. The user is assigned groups in the IdP but does not get placed in the expected Docker Team.
6162
3. Review Docker logs or IdP logs to find the error message.
6263

63-
#### Solutions
64+
### Solutions
6465

6566
Update group names in your IdP:
6667
1. Go to your IdP's group management section.
@@ -71,20 +72,20 @@ Update group names in your IdP:
7172

7273
## User is not assigned to the organization
7374

74-
#### Error message
75+
### Error message
7576

7677
When this issue occurs, the following error message is common:
7778
```text
7879
User '$username' is not assigned to this SSO organization. Contact your administrator. TraceID: XXXXXXXXXXXXX
7980
```
8081

81-
#### Possible causes
82+
### Possible causes
8283

8384
- User is not assigned to the organization: If Just-in-Time (JIT) provisioning is disabled, the user may not be assigned to your organization.
8485
- User is not invited to the organization: If JIT is disabled and you do not want to enable it, the user must be manually invited.
8586
- SCIM provisioning is misconfigured: If you use SCIM for user provisioning, it may not be correctly syncing users from your IdP.
8687

87-
#### Solutions
88+
### Solutions
8889

8990
**Enable JIT provisioning**
9091

@@ -116,18 +117,18 @@ If you have SCIM enabled, troubleshoot your SCIM connection using the following
116117

117118
## IdP-initiated sign in is not enabled for connection
118119

119-
#### Error message
120+
### Error message
120121

121122
When this issue occurs, the following error message is common:
122123
```text
123124
IdP-Initiated sign in is not enabled for connection '$ssoConnection'.
124125
```
125126

126-
#### Possible causes
127+
### Possible causes
127128

128129
Docker does not support an IdP-initiated SAML flow. This error occurs when a user attempts to authenticate from your IdP, such as using the Docker SSO app tile on the sign in page.
129130

130-
#### Solutions
131+
### Solutions
131132

132133
**Authenticate from Docker apps**
133134

@@ -139,18 +140,18 @@ You can hide the Docker SSO app from users in your IdP. This prevents users from
139140

140141
## Not enough seats in organization
141142

142-
#### Error message
143+
### Error message
143144

144145
When this issue occurs, the following error message is common:
145146
```text
146147
Not enough seats in organization '$orgName'. Add more seats or contact your administrator.
147148
```
148149

149-
#### Possible causes
150+
### Possible causes
150151

151152
This error occurs when the organization has no available seats for the user when provisioning via Just-in-Time (JIT) provisioning or SCIM.
152153

153-
#### Solutions
154+
### Solutions
154155

155156
**Add more seats to the organization**
156157

@@ -162,20 +163,20 @@ Review your organization members and pending invitations. Remove inactive users
162163

163164
## Domain is not verified for SSO connection
164165

165-
#### Error message
166+
### Error message
166167

167168
When this issue occurs, the following error message is common:
168169
```text
169170
Domain '$emailDomain' is not verified for your SSO connection. Contact your company administrator. TraceID: XXXXXXXXXXXXXX
170171
```
171172

172-
#### Possible causes
173+
### Possible causes
173174

174175
This error occurs if the IdP authenticated a user through SSO and the User Principal Name (UPN)
175176
returned to Docker doesn’t match any of the verified domains associated to the
176177
SSO connection configured in Docker.
177178

178-
#### Solutions
179+
### Solutions
179180

180181
**Verify UPN attribute mapping**
181182

@@ -187,20 +188,20 @@ Add and verify all domains and subdomains used as UPN by your IdP and associate
187188

188189
## Unable to find session
189190

190-
#### Error message
191+
### Error message
191192

192193
When this issue occurs, the following error message is common:
193194
```text
194195
We couldn't find your session. You may have pressed the back button, refreshed the page, opened too many sign-in dialogs, or there is some issue with cookies. Try signing in again. If the issue persists, contact your administrator.
195196
```
196197

197-
#### Possible causes
198+
### Possible causes
198199

199200
The following causes may create this issue:
200201
- The user pressed the back or refresh button during authentication.
201202
- The authentication flow lost track of the initial request, preventing completion.
202203

203-
#### Solutions
204+
### Solutions
204205

205206
**Do not disrupt the authentication flow**
206207

@@ -212,20 +213,20 @@ Close the browser tab and restart the authentication flow from the Docker applic
212213

213214
## Name ID is not an email address
214215

215-
#### Error message
216+
### Error message
216217

217218
When this issue occurs, the following error message is common:
218219
```text
219220
The name ID sent by the identity provider is not an email address. Contact your company administrator.
220221
```
221222

222-
#### Possible causes
223+
### Possible causes
223224

224225
The following causes may create this issue:
225226
- The IdP sends a Name ID (UPN) that does not comply with the email format required by Docker.
226227
- Docker SSO requires the Name ID to be the primary email address of the user.
227228

228-
#### Solutions
229+
### Solutions
229230

230231
In your IdP, ensure the Name ID attribute format is correct:
231232
1. Verify that the Name ID attribute format in your IdP is set to `EmailAddress`.

0 commit comments

Comments
 (0)