Skip to content

docs: add new steps for org sync through ui #15768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions docs/admin/users/idp-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -420,36 +420,27 @@ settings, a user's memberships will update when they log out and log back in.
Depending on the OIDC provider, this claim may be called something else.
Common names include `groups`, `memberOf`, and `roles`.

1. Configure the Coder server to read groups from the claim name with the OIDC
organization field server flag:

```sh
# as an environment variable
CODER_OIDC_ORGANIZATION_FIELD=groups
```

1. Fetch the corresponding organization IDs using the following endpoint:

```text
https://[coder.example.com]/api/v2/organizations
```

1. Set the following in your Coder server [configuration](../setup/index.md).
1. As a Coder organization user admin or site-wide user admin, go to
**Settings** > **IdP organization sync**.

```env
CODER_OIDC_ORGANIZATION_MAPPING='{"data-scientists":["d8d9daef-e273-49ff-a832-11fe2b2d4ab1", "70be0908-61b5-4fb5-aba4-4dfb3a6c5787"]}'
```
1. In the **Organization sync field** text box, enter the organization claim,
then select **Save**.

> One claim value from your identity provider can be mapped to many
> organizations in Coder. The example above maps to two organizations in
> Coder.
Users are automatically added to the default organization.

1. By default, all users are assigned to the default (first) organization. You
can disable that with:
Do not disable **Assign Default Organization**. If you disable the default
organization, the system will remove users who are already assigned to it.

```env
CODER_OIDC_ORGANIZATION_ASSIGN_DEFAULT=false
```
1. Enter an IdP organization name and Coder organization(s), then select **Add
IdP organization**:

![IdP organization sync](../../images/admin/users/organizations/idp-org-sync.png)

</div>

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading