a6581c7157
chore: update OIDC scopes to include offline_access ( #20876 )
...
This is an update to
https://coder.com/docs/admin/users/oidc-auth/microsoft#enable-refresh-tokens-recommended .
We recommend users enable refresh tokens but don't actually give them
the env var value to add.
https://coder.com/docs/admin/users/oidc-auth/refresh-tokens does a good
job of including `offline_access` in the list, so the first page should
align with this.
2025-11-24 07:04:21 +05:00
0cd33d1abb
chore(docs/admin/users): fix typo in headless auth page ( #20841 )
2025-11-20 11:25:54 +01:00
a2728439ff
docs: add API key scopes documentation ( #20742 )
...
## Description
Adds a brief section to the API & Session Tokens documentation
explaining API key scopes.
## Changes
- Added "API Key Scopes" section to
`docs/admin/users/sessions-tokens.md`
- Includes overview of scope functionality and security benefits
- Documents scope format (`resource:action`) and wildcard usage
- Provides CLI examples for creating scoped tokens
- Lists common scope examples with descriptions
## Motivation
Users need documentation on how to create and use scoped API tokens for
improved security by limiting token permissions to only necessary
operations.
## Testing
- Reviewed documentation formatting
- Verified markdown structure
- Confirmed examples are accurate
2025-11-17 11:34:01 -06:00
1d1e1f92b0
docs: add OIDC documentation for Microsoft Entra ID user auth ( #20202 )
...
Propose Microsoft Entra ID OIDC Directions for Admin Documentation based
on my personal experience / setup.
Propose information on changing access URL in Tutorials -> FAQs
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com >
Co-authored-by: DevCats <chris@dualriver.com >
Co-authored-by: DevelopmentCats <christofer@coder.com >
2025-11-07 16:33:51 +05:00
ea7025b562
docs(admin/users): add google provider-specific guide ( #19309 )
...
## Summary
- Add a provider-specific guide for configuring Google as an OIDC
provider
- Document refresh token setup via CODER_OIDC_AUTH_URL_PARAMS
- Add page to docs navigation under Users → OIDC Authentication
## Test plan
- Docs site builds: `docs/admin/users/oidc-auth/google.md` renders
- Nav shows 'Google' under OIDC Authentication
- Links to OIDC overview and refresh tokens work
Fixes #13508
---------
Co-authored-by: Atif Ali <atif@coder.com >
2025-08-12 13:02:40 -05:00
d05a15cb12
fix: adjust the kubectl exec example ( #19148 )
...
Current example fails since kubectl version 1.31:
```sh
$ kubectl exec -it deployment/coder /bin/bash -n coder
error: exec [POD] [COMMAND] is not supported anymore. Use exec [POD] -- [COMMAND] instead
```
The legacy syntax was removed in:
https://github.com/kubernetes/kubernetes/pull/125437
2025-08-04 21:24:09 +02:00
998fbdfbb3
docs: use CODER_LOG_FILTER instead of CODER_VERBOSE ( #19105 )
...
closes #18833
replace suggestions to use the now-deprecated `CODER_VERBOSE` with more
specific `CODER_LOG_FILTER`
thanks @UnicornyRainbow!
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-07-30 12:35:45 -04:00
072c81cd73
docs: remove nested alerts ( #18580 )
...
hotfix
removes nested gfm alerts, which is a known ~issue~ feature
https://github.com/orgs/community/discussions/16925#discussioncomment-12043928
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-06-25 15:17:49 +00:00
5c16079aff
docs: add more specific steps and information about oidc refresh tokens ( #18336 )
...
closes https://github.com/coder/coder/issues/18307
relates to https://github.com/coder/coder/pull/18318
preview:
-
[refresh-tokens](https://coder.com/docs/@18307-refresh-tokens/admin/users/oidc-auth/refresh-tokens )
-
[configuring-okta](https://coder.com/docs/@18307-refresh-tokens/tutorials/configuring-okta )
~(not sure why @Emyrk 's photo is so huge there though)~ ✔️
- [x] removed from
[idp-sync](https://coder.com/docs/@18307-refresh-tokens/admin/users/idp-sync )
to do:
- move keycloak
- add ping federate and azure
- edit text (possibly placeholders for now - I want to see how it all
relates and edit it again. right now, there's a note about the same
thing in every section in way that's not super helpful/necessary)
- ~convert some paragraphs to OL~ calling this out of scope for now
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-06-16 13:18:55 -04:00
8e1ccf9f80
chore: update IdP docs with Google quirks ( #18318 )
...
Following some issues we discovered on dogfood after merging #17878 , we
think `prompt=consent` is required for refresh tokens to be sent by
Google every time you sign in.
2025-06-11 15:02:08 -04:00
345001ffd1
docs: update the GitHub Auth section ( #17769 )
...
Addresses https://github.com/coder/coder/issues/17752
[preview](https://coder.com/docs/@hugodutka%2Fgithub%2Dauth%2Dorg%2Ddocs/admin/users/github-auth )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-05-29 15:38:45 +00:00
4cb35c4c65
docs: fix token create command ( #17984 )
...
`--name` is required
2025-05-22 10:39:51 -04:00
f9817af11f
docs: add section on how to retrieve user list ( #17798 )
...
previews
- [admin/users](https://coder.com/docs/@export-coder-users/admin/users )
-
[reference/cli/users](https://coder.com/docs/@export-coder-users/reference/cli/users )
followup to slack thread:
> Tim
> what's the best way for customers to export a list of Coder users?
>
> @ericpaulsen
> the `/api/v2/users` API route returns all users in the deployment
(along with other information - email, status, username, etc.). from
<https://coder.com/docs/reference/api/users#get-users >
- adds an easy-to-find section to the admin/users doc
- updates the cli commands with short descriptions
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-05-13 20:48:16 +00:00
34752fa148
docs: add note about sign in with GitHub button should be hidden when flow is disabled ( #17367 )
...
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-14 17:03:25 +05:00
0e658219b2
feat: support filtering users table by login type ( #17238 )
...
#15896 Mentions ability to add support for filtering by login type
The issue mentions that backend API support exists but the backend did
not seem to have the support for this filter. So I have added the
ability to filter it.
I also added a corresponding update to readme file to make sure the docs
will correctly showcase this feature
2025-04-09 13:59:41 +10:00
f475555d06
docs: document that default GitHub app requires device flow ( #17162 )
...
## Issue
Closes #16824
Document that the default GitHub authentication app provided by Coder
requires device flow, and that this behavior cannot be overridden.
## Changes Made
Claude updated the GitHub authentication documentation to:
1. Add a prominent warning in the Default Configuration section
explaining that the default GitHub app requires device flow and ignores
the `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting
2. Clarify the Device Flow section to indicate that:
- Device flow is always enabled for the default GitHub app
- Device flow is optional for custom GitHub OAuth apps
- The `CODER_OAUTH2_GITHUB_DEVICE_FLOW` setting is ignored when using
the default app
[preview](https://coder.com/docs/@16824-github-device-flow/admin/users/github-auth )
<sub>🤖 Generated with [Claude Code](https://claude.ai/code )</sub>
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Claude <noreply@anthropic.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-04-05 21:44:13 -04:00
0fe7346264
docs: remove enterprise from docs ( #17226 )
...
Enterprise is a legacy plan that has been replaced by Premium.
[preview](https://coder.com/docs/@enterprise-feats )
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-02 16:51:57 -04:00
0ec87abaa5
docs: add new section on managing provisioners from the dashboard ( #16563 )
...
closes #16513
[preview](https://coder.com/docs/@16513-manage-ext-provisioners/admin/provisioners/manage-provisioner-jobs )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-04-01 21:04:31 -05:00
101b62dc3e
docs: convert alerts to use GitHub Flavored Markdown (GFM) ( #16850 )
...
followup to #16761
thanks @lucasmelin !
+ thanks: @ethanndickson @Parkreiner @matifali @aqandrew
- [x] update snippet
- [x] find/replace
- [x] spot-check
[preview](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule )
(and others)
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: M Atif Ali <atif@coder.com >
2025-03-10 16:58:20 -04:00
0f4f6bd147
docs: describe default sign up behavior with GitHub ( #16765 )
...
Document the sign up behavior with the default GitHub OAuth2 app.
2025-03-03 13:23:12 +01:00
a5842e5ad1
docs: document default GitHub OAuth2 configuration and device flow ( #16663 )
...
Document the changes made in https://github.com/coder/coder/pull/16629
and https://github.com/coder/coder/pull/16585 .
2025-03-03 12:31:56 +01:00
a69961bbd2
docs: add mention of CLI command to create token on behalf of another user ( #15138 )
...
this was completed by #14813 , but not documented
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-14 07:53:19 -06:00
e289578721
docs: remove beta and closed issues from orgs doc ( #16361 )
...
## hold for release
track https://github.com/coder/coder/pull/16411
closes https://github.com/coder/internal/issues/291
[preview](https://coder.com/docs/@291-orgs-ga/admin/users/organizations )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2025-02-05 13:19:35 -05:00
cf96455901
fix(docs): indicate that custom roles are premium only ( #16434 )
...
our docs incorrectly stated that custom roles were included in the
now-deprecated Enterprise plan. this is PR implements the fix.
2025-02-04 20:19:14 +00:00
a15f06a7e3
docs: simplify OIDC config instructions ( #16266 )
2025-02-04 12:50:37 +05:00
92a490b3b6
docs: update IdP group and role sync documentation for UI configuration ( #16315 )
2025-01-31 20:39:03 +00:00
3897ea458b
docs: adjust steps and add screenshots for orgs ( #16248 )
...
first in a series of updates to orgs docs
2025-01-29 12:58:55 -05:00
94f5d52fdc
chore: adopt markdownlint and markdown-table-formatter for *.md ( #15831 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-01-03 13:12:59 +00:00
c9eb06eb97
chore: remove dead link to azure docs issues ( #15982 )
2024-12-31 16:17:59 +05:00
1eba4c08cb
docs: add beta back to orgs ( #15902 )
...
I merged https://github.com/coder/coder/pull/15888/ too early.
This PR incorporates @matifali 's edit suggestions
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 13:37:26 -05:00
21cc6f77fe
docs: move premium and enterprise badges from heading to info in admonition ( #15774 )
...
closes https://github.com/coder/coder.com/issues/666
[preview](https://coder.com/docs/@666-unheading-premium/user-guides/workspace-scheduling#autostop-requirement )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 18:20:01 +00:00
468ffd9919
docs: copy edit the organizations doc and add link to best practices ( #15888 )
...
[preview](https://coder.com/docs/@orgs-edit-202412/admin/users/organizations )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 10:44:21 +05:00
e191d9650c
feat: support created_at filter for the GET /users endpoint ( #15633 )
...
Closes https://github.com/coder/coder/issues/12747
We support these filters currently:
https://coder.com/docs/v2/latest/admin/users#user-filtering , adding
`created_at` filter as well.
2024-12-17 15:24:54 +11:00
5e7199233c
docs: add cli steps for org sync ( #15673 )
...
[preview](https://coder.com/docs/@15431-docs-org-sync/admin/users/idp-sync#organization-sync-premium )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-10 11:09:41 -05:00
fa69d1ca74
ci: reenable link checker & fix broken links ( #15489 )
...
Follow-up on #15484 .
2024-11-13 16:04:10 +11:00
e9fbfcc45b
chore(docs): include custom roles examples and mention of password reset ( #15294 )
...
Added example custom roles for admin inspiration, mention of headless
authentication use case, and user-activated password reset.
2024-10-30 11:41:52 -05:00
25738388d5
chore(docs): add documentation on custom roles ( #15280 )
...
These docs were overwritten in the restructure merge.
2024-10-29 20:58:26 -05:00
89ff48744c
chore(docs): fix broken or missing links ( #15085 )
...
Fixes a number of TODOs and broken links.
2024-10-15 16:50:49 +01:00
419eba5fb6
docs: restructure docs ( #14421 )
...
Closes #13434
Supersedes #14182
---------
Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com >
Co-authored-by: Ethan Dickson <ethan@coder.com >
Co-authored-by: Ben Potter <ben@coder.com >
Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com >
Co-authored-by: Stephen Kirby <me@skirby.dev >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-10-05 10:52:04 -05:00
Rowan Smith