Skip to content

Commit 7900135

Browse files
committed
confirm oidc sends claims; remove future versions notes
1 parent 1f56d58 commit 7900135

File tree

1 file changed

+27
-97
lines changed

1 file changed

+27
-97
lines changed

docs/admin/users/idp-sync.md

Lines changed: 27 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,27 @@ IdP sync is an Enterprise and Premium feature.
88

99
</blockquote>
1010

11+
## Confirm that OIDC provider sends claims
12+
13+
To confirm that your OIDC provider is sending claims, log in with OIDC and visit
14+
the following URL with an `Owner` account:
15+
16+
```text
17+
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
18+
```
19+
20+
You should see a field in either `id_token_claims`, `user_info_claims` or
21+
both followed by a list of the user's OIDC groups in the response.
22+
23+
This is the [claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims)
24+
sent by the OIDC provider.
25+
26+
Depending on the OIDC provider, this claim may be called something else.
27+
Common names include `groups`, `memberOf`, and `roles`.
28+
29+
See the [troubleshooting section](#troubleshooting-grouproleorganization-sync)
30+
for help troubleshooting common issues.
31+
1132
## Group Sync
1233

1334
If your OpenID Connect provider supports group claims, you can configure Coder
@@ -35,25 +56,6 @@ You can use the dashboard to configure group sync instead.
3556

3657
</blockquote>
3758

38-
1. Confirm that your OIDC provider is sending claims.
39-
40-
Log in with OIDC and visit the following URL with an `Owner` account:
41-
42-
```text
43-
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
44-
```
45-
46-
You should see a field in either `id_token_claims`, `user_info_claims` or
47-
both followed by a list of the user's OIDC groups in the response. This is
48-
the [claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims)
49-
sent by the OIDC provider.
50-
51-
See [Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug
52-
this.
53-
54-
Depending on the OIDC provider, this claim may be called something else.
55-
Common names include `groups`, `memberOf`, and `roles`.
56-
5759
1. Configure the Coder server to read groups from the claim name with the
5860
[OIDC group field](../../reference/cli/server.md#--oidc-group-field) server
5961
flag:
@@ -107,31 +109,11 @@ OIDC provider will be added to the `myCoderGroupName` group in Coder.
107109
### Runtime (Organizations)
108110

109111
For deployments with multiple [organizations](./organizations.md), you must
110-
configure group sync at the organization level. In future Coder versions, you
111-
will be able to configure this in the UI. For now, you must use CLI commands.
112+
configure group sync at the organization level.
112113

113114
1. Confirm you have the [Coder CLI](../../install/index.md) installed and are
114115
logged in with a user who is an Owner or Organization Admin role.
115116

116-
1. Confirm that your OIDC provider is sending a groups claim.
117-
118-
Log in with OIDC and visit the following URL:
119-
120-
```text
121-
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
122-
```
123-
124-
You should see a field in either `id_token_claims`, `user_info_claims` or
125-
both followed by a list of the user's OIDC groups in the response. This is
126-
the [claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims)
127-
sent by the OIDC provider.
128-
129-
See [Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug
130-
this.
131-
132-
Depending on the OIDC provider, this claim may be called something else.
133-
Common names include `groups`, `memberOf`, and `roles`.
134-
135117
1. To fetch the current group sync settings for an organization, run the
136118
following:
137119

@@ -230,23 +212,6 @@ You can use the dashboard to configure role sync instead.
230212

231213
</blockquote>
232214

233-
1. Confirm that your OIDC provider is sending a roles claim by logging in with
234-
OIDC and visiting the following URL with an `Owner` account:
235-
236-
```text
237-
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
238-
```
239-
240-
You should see a field in either `id_token_claims`, `user_info_claims` or
241-
both followed by a list of the user's OIDC roles in the response. This is the
242-
[claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims) sent by
243-
the OIDC provider.
244-
245-
See [Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug
246-
this.
247-
248-
Depending on the OIDC provider, this claim may be called something else.
249-
250215
1. Configure the Coder server to read groups from the claim name with the
251216
[OIDC role field](../../reference/cli/server.md#--oidc-user-role-field)
252217
server flag:
@@ -268,26 +233,7 @@ example above maps to two roles in Coder.
268233
### Runtime (Organizations)
269234

270235
For deployments with multiple [organizations](./organizations.md), you can
271-
configure role sync at the organization level. In future Coder versions, you
272-
will be able to configure this in the UI. For now, you must use CLI commands.
273-
274-
1. Confirm that your OIDC provider is sending a roles claim.
275-
276-
Log in with OIDC and visit the following URL with an `Owner` account:
277-
278-
```text
279-
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
280-
```
281-
282-
You should see a field in either `id_token_claims`, `user_info_claims` or
283-
both followed by a list of the user's OIDC roles in the response. This is the
284-
[claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims) sent by
285-
the OIDC provider.
286-
287-
See [Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug
288-
this.
289-
290-
Depending on the OIDC provider, this claim may be called something else.
236+
configure role sync at the organization level.
291237

292238
1. To fetch the current group sync settings for an organization, run the
293239
following:
@@ -362,30 +308,14 @@ dashboard:
362308
363309
### Dashboard
364310
365-
1. Confirm that your OIDC provider is sending claims. Log in with OIDC and visit
366-
the following URL with an `Owner` account:
367-
368-
```text
369-
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
370-
```
371-
372-
You should see a field in either `id_token_claims`, `user_info_claims` or
373-
both followed by a list of the user's OIDC groups in the response. This is
374-
the [claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims)
375-
sent by the OIDC provider. See
376-
[Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug this.
377-
378-
Depending on the OIDC provider, this claim may be called something else.
379-
Common names include `groups`, `memberOf`, and `roles`.
380-
381311
1. Fetch the corresponding organization IDs using the following endpoint:
382312
383313
```text
384314
https://[coder.example.com]/api/v2/organizations
385315
```
386316
387317
1. As a Coder organization user admin or site-wide user admin, go to
388-
**Settings** > **IdP organization sync**.
318+
**Admin settings** > **Deployment** and select **IdP organization sync**.
389319
390320
1. In the **Organization sync field** text box, enter the organization claim,
391321
then select **Save**.
@@ -452,11 +382,11 @@ settings, a user's memberships will update when they log out and log back in.
452382
453383
## Troubleshooting group/role/organization sync
454384
455-
Some common issues when enabling group/role sync.
385+
Some common issues when enabling group, role, or organization sync.
456386
457387
### General guidelines
458388
459-
If you are running into issues with group/role sync:
389+
If you are running into issues with a sync:
460390
461391
1. View your Coder server logs and enable
462392
[verbose mode](../../reference/cli/index.md#-v---verbose).
@@ -472,7 +402,7 @@ If you are running into issues with group/role sync:
472402
473403
1. Attempt to log in, preferably with a user who has the `Owner` role.
474404
475-
The logs for a successful group sync look like this (human-readable):
405+
The logs for a successful sync look like this (human-readable):
476406
477407
```sh
478408
[debu] coderd.userauth: got oidc claims request_id=49e86507-6842-4b0b-94d4-f245e62e49f3 source=id_token claim_fields="[aio aud email exp groups iat idp iss name nbf oid preferred_username rh sub tid uti ver]" blank=[]

0 commit comments

Comments
 (0)