diff --git a/docs/admin/users.md b/docs/admin/users.md index 39e7b994f044d..b85a4256110d1 100644 --- a/docs/admin/users.md +++ b/docs/admin/users.md @@ -129,3 +129,15 @@ kubectl exec -it deployment/coder /bin/bash -n coder coder reset-password ``` + +## 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. diff --git a/docs/workspaces.md b/docs/workspaces.md index d2d11e88f8382..43b61f595b305 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -90,6 +90,19 @@ Coder stores macOS and Linux logs at the following locations: > Note: Logs are truncated once they reach 5MB in size. +## Workspace filtering + +In the Coder UI, you can filter your workspaces using pre-defined filters or employing the Coder's filter query. Take a look at the following examples to understand how to use the Coder's filter query: + +- To find the workspaces that you own, use the filter `owner:me`. +- To find workspaces that are currently running, use the filter `status:running`. + +The following filters are supported: + +- `owner` - Represents the `username` of the owner. You can also use `me` as a convenient alias for the logged-in user. +- `template` - Specifies the name of the template. +- `status` - Indicates the status of the workspace. For a list of supported statuses, please refer to the [WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus). + --- ## Up next