Skip to content

docs: add docs for the available query filter for workspaces and users #7875

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.

Sign up for GitHub

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 5 commits into from
Jun 6, 2023
Merged

docs: add docs for the available query filter for workspaces and users #7875

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
15ddf2a
Add docs for user filtering
BrunoQuaresma Jun 6, 2023
2c3b030
Add filter for workspace
BrunoQuaresma Jun 6, 2023
3c0be72
Apply suggestions from code review
BrunoQuaresma Jun 6, 2023
c4056c5
Update docs/admin/users.md
matifali Jun 6, 2023
2408b82
Apply suggestions from code review
matifali Jun 6, 2023
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
Next Next commit
Add docs for user filtering
  • Loading branch information
@BrunoQuaresma
BrunoQuaresma committed Jun 6, 2023
commit 15ddf2a3fb903b706422d33a226fbedd089f19be
12 changes: 12 additions & 0 deletions docs/admin/users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,15 @@ kubectl exec -it deployment/coder /bin/bash -n coder

coder reset-password <username>
```

## Filtering users

In the Coder UI you can filter your users using the pre-defined filter or by using the Coder's filter query like the examples below:

- `status:active` to find active users
- `role:admin` to find admin users

The supported filters are:

- `status` - The status of the user. It can be a `active` or `suspended`.
- `role` - The role of the user. You can [find here](https://pkg.go.dev/github.com/coder/coder/codersdk#TemplateRole) all the user roles that are supported.