eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-04-26 01:25:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

website/docs: Advanced queries, remove reference to QL and add more examples (#16191)

Browse Source 
* remove reference to QL

* add Jens' examples

* tweak

* Update website/docs/users-sources/user/user_basic_operations.md

Co-authored-by: Jens L. <jens@goauthentik.io>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* Update website/docs/users-sources/user/user_basic_operations.md

Co-authored-by: Jens L. <jens@goauthentik.io>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* add note about UX ticks

* tweak

* argh

* clarify there are more values

* add link to Event actions list

* tweaks, typo

* Update website/docs/users-sources/user/user_basic_operations.md

Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* Update website/docs/sys-mgmt/events/logging-events.md

Co-authored-by: Jens L. <jens@goauthentik.io>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>

* jens edits

---------

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Tana M Berry <tana@goauthentik.io>
Co-authored-by: Jens L. <jens@goauthentik.io>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io>
This commit is contained in:
Tana M Berry
2025-08-19 15:27:00 -04:00
committed by GitHub
parent 8029fdad7b
commit 109c869f97
3 changed files with 36 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
website/docs/users-sources/user/user_basic_operations.md
View File

@@ -35,29 +35,25 @@ To create a super-user, you need to add the user to a group that has super-user
## Advanced queries for users:ak-enterprise {#tell-me-more}
You can construct advanced queries, based on [DjangoQL](https://github.com/ivelum/djangoql), to find specific users in the list under **Directory > Users**. Use the auto-complete in the **Search** field or enter your own queries to return results with greater specificity.
You can create advanced queries to locate specific users within the list shown under **Directory** > **Users** in the Admin interface. Use the auto-complete in the **Search** field or enter your own queries to return results with greater specificity.
<!--| Model/Object | Operators | Examples |
| ---- | ---- | ----------- |
| `username` | `=` | `username = "Joel Bonne"` |
| `path` | != | |
| `name` | ~| |
| `email` | !~ |
| `path` | `startswith` |
| `is_active` | `not startswith` |
| `type` | `endswith` |
| `attributes`| `endswith` |
| | `not endswith` |
| | `in` |
| | `not in` |-->
- **Model/object**: `username`, `path`, `name`, `email`, `path`, `is_active`, `type`, `attributes`
- **Field**: `username`, `path`, `name`, `email`, `path`, `is_active`, `type`, `attributes`
- **Operators**: `=`, `!=`, `~`, `!~`, `startswith`, `not startswith`, `endswidth`, `not endswith`, `in`, `not in`
- **Values**: `True`, `False`, `None`
- **Values**: `True`, `False`, `None`, and more
- **Example queries**: `username = "Joel Bonne"`, `is_active = false`
- **Example queries**:
- search user by status: `is_active = False`
- search user by username: `username = "bob"`
- search user by email address: `email = "bob@authentik.company"`
- search user by attribute: `attribute.my_custom_attribute = "foo"`
:::info
1. To dismiss the drop-down menu option, click **ESC**.
2. If the list of operators does not appear in a drop-down menu you will need to manually enter it.
:::
## View user details