synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-08-01 08:28:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* Add docs for user filtering

* Add filter for workspace

* Apply suggestions from code review

Co-authored-by: Muhammad Atif Ali <atif@coder.com>

---------

Co-authored-by: Muhammad Atif Ali <atif@coder.com>
This commit is contained in:
Bruno Quaresma
2023-06-06 12:12:10 -03:00
committed by GitHub
parent 3121ccc7ff
commit 944c42dcb6
2 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/admin/users.md
View File

@@ -129,3 +129,15 @@ kubectl exec -it deployment/coder /bin/bash -n coder
coder reset-password <username>
```
## User filtering
In the Coder UI, you can filter your users using pre-defined filters or by utilizing the Coder's filter query. The examples provided below demonstrate how to use the Coder's filter query:
- To find active users, use the filter `status:active`.
- To find admin users, use the filter `role:admin`.
The following filters are supported:
- `status` - Indicates the status of the user. It can be either `active` or `suspended`.
- `role` - Represents the role of the user. You can refer to the [TemplateRole documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#TemplateRole) for a list of supported user roles.