Skip to content

Commit 1879e11

Browse files
committed
dashboard tab to default
1 parent b336e3b commit 1879e11

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

docs/admin/users/idp-sync.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,46 @@ dashboard:
354354

355355
<div class="tabs">
356356

357+
### Dashboard
358+
359+
1. Confirm that your OIDC provider is sending claims. Log in with OIDC and visit
360+
the following URL with an `Owner` account:
361+
362+
```text
363+
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
364+
```
365+
366+
You should see a field in either `id_token_claims`, `user_info_claims` or
367+
both followed by a list of the user's OIDC groups in the response. This is
368+
the [claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims)
369+
sent by the OIDC provider. See
370+
[Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug this.
371+
372+
Depending on the OIDC provider, this claim may be called something else.
373+
Common names include `groups`, `memberOf`, and `roles`.
374+
375+
1. Fetch the corresponding organization IDs using the following endpoint:
376+
377+
```text
378+
https://[coder.example.com]/api/v2/organizations
379+
```
380+
381+
1. As a Coder organization user admin or site-wide user admin, go to
382+
**Settings** > **IdP organization sync**.
383+
384+
1. In the **Organization sync field** text box, enter the organization claim,
385+
then select **Save**.
386+
387+
Users are automatically added to the default organization.
388+
389+
Do not disable **Assign Default Organization**. If you disable the default
390+
organization, the system will remove users who are already assigned to it.
391+
392+
1. Enter an IdP organization name and Coder organization(s), then select **Add
393+
IdP organization**:
394+
395+
![IdP organization sync](../../images/admin/users/organizations/idp-org-sync.png)
396+
357397
### CLI
358398
359399
Use the Coder CLI to show and adjust the settings.
@@ -402,46 +442,6 @@ settings, a user's memberships will update when they log out and log back in.
402442
| mapping | Mapping takes a claim from the IdP, and associates it with 1 or more organizations by UUID. </br> No validation is done, so you can put UUID's of orgs that do not exist (a noop). The UI picker will allow selecting orgs from a drop down, and convert it to a UUID for you. |
403443
| organization_assign_default | This setting exists for maintaining backwards compatibility with single org deployments, either through their upgrade, or in perpetuity. </br> If this is set to 'true', all users will always be assigned to the default organization regardless of the mappings and their IdP claims. |
404444
405-
### Dashboard
406-
407-
1. Confirm that your OIDC provider is sending claims. Log in with OIDC and visit
408-
the following URL with an `Owner` account:
409-
410-
```text
411-
https://[coder.example.com]/api/v2/debug/[your-username]/debug-link
412-
```
413-
414-
You should see a field in either `id_token_claims`, `user_info_claims` or
415-
both followed by a list of the user's OIDC groups in the response. This is
416-
the [claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims)
417-
sent by the OIDC provider. See
418-
[Troubleshooting](#troubleshooting-grouproleorganization-sync) to debug this.
419-
420-
Depending on the OIDC provider, this claim may be called something else.
421-
Common names include `groups`, `memberOf`, and `roles`.
422-
423-
1. Fetch the corresponding organization IDs using the following endpoint:
424-
425-
```text
426-
https://[coder.example.com]/api/v2/organizations
427-
```
428-
429-
1. As a Coder organization user admin or site-wide user admin, go to
430-
**Settings** > **IdP organization sync**.
431-
432-
1. In the **Organization sync field** text box, enter the organization claim,
433-
then select **Save**.
434-
435-
Users are automatically added to the default organization.
436-
437-
Do not disable **Assign Default Organization**. If you disable the default
438-
organization, the system will remove users who are already assigned to it.
439-
440-
1. Enter an IdP organization name and Coder organization(s), then select **Add
441-
IdP organization**:
442-
443-
![IdP organization sync](../../images/admin/users/organizations/idp-org-sync.png)
444-
445445
</div>
446446
447447
## Troubleshooting group/role/organization sync

0 commit comments

Comments
 (0)