This repository was archived by the owner on Aug 18, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 82
chore: rewrite/reorg access control docs #827
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: Authentication management | ||
description: Learn how to manage Coder authentication. | ||
--- | ||
|
||
By default, Coder enables **built-in authentication**, though you can change | ||
this if desired. | ||
|
||
To do so, go to **Manage** > **Users**. Find the user whose authentication type | ||
you want to change, and use the **Auth Type** to toggle between **Built-In** and | ||
**OpenID Connect**. | ||
|
||
If you opt for **OpenID Connect**, you'll need to provide additional | ||
configuration steps, which are detailed in the subsequent sections of this | ||
article. | ||
|
||
## Set up OIDC authentication | ||
|
||
To set up OIDC authentication, you'll first need to register a Coder application | ||
with your OIDC provider. During this process, you'll be asked to provide a | ||
domain name for the OIDC token callback; use | ||
`https://coder.my-company.com/oidc/callback`. | ||
|
||
Once you've registered a Coder application with your OIDC provider, you'll need | ||
to return to Coder and complete the setup process. Under **Admin** > **Manage** > | ||
**Authentication**, make sure that you've selected **OpenID Connect** as the | ||
authentication type. Then, provide the following parameters: | ||
|
||
- **Client ID**: The client ID for the Coder application you registered with the | ||
OIDC provider | ||
- **Client Secret**: The secret assigned to the Coder application you registered | ||
with the OIDC provider | ||
- **Issuer** (e.g., `https://my-idp.com/realm/my-org`): The URL where Coder can | ||
find your OIDC provider's configuration document | ||
|
||
> If you do not have values for any of these parameters, you can obtain them | ||
> from your OIDC provider. | ||
|
||
There are several additional configuration parameters that may be of interest to | ||
you: | ||
|
||
- **Enable Access Tokens:** Toggle **On** if you'd like to allow users to fetch | ||
tokens from `https://<yourDomain>/api/v0/users/me/oidc-access-token` | ||
- **Additional Scopes:** Specify any scopes (beyond the default) that you would | ||
like Coder to request during the login process | ||
- **Disable built-in authentication:** Choose whether Coder removes the ability | ||
to log in with an email/password option when you've enabled OIDC | ||
authentication | ||
|
||
### Disable built-in authentication | ||
|
||
You can disable built-in authentication as an option for accessing Coder if you | ||
have OIDC configured. | ||
|
||
 | ||
|
||
[Site managers](users/user-roles#site-manager-permissions) can still use | ||
built-in authentication. To view this option on the login page, add the | ||
following query parameter to the URL you use to access your Coder deployment: | ||
|
||
```text | ||
/login?showAllAuthenticationTypes=1 | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.