Skip to content

Commit 9c9a6e3

Browse files
tanberryTana M Berry
andauthored
website/docs: add content about new Advanced Query searches (#16019)
Co-authored-by: Tana M Berry <tana@goauthentik.io>
1 parent 2cd81b2 commit 9c9a6e3

File tree

3 files changed

+47
-9
lines changed

3 files changed

+47
-9
lines changed

website/docs/releases/2025/v2025.8.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To try out the release candidate, replace your Docker image tag with the latest
1717

1818
![Screenshot of the admin interface showing events plotted on a histogram chart and on a map](../../sys-mgmt/events/event-map-chart.png)
1919

20-
- **Advanced search**: :ak-enterprise Search for users and events with custom query language to filter on their properties and attributes.
20+
- **Advanced search**: :ak-enterprise Search for [users](../../users-sources/user/user_basic_operations.md#tell-me-more) and [event logs](../../sys-mgmt/events/logging-events.md#tell-me-more) with custom query language to filter on their properties and attributes.
2121

2222
- **Email stage rate limiting**: The email stage can now be configured to set a maximum number of emails that can be sent within a specified time period.
2323

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,20 @@ You can view audit details in the following areas of the authentik Admin interfa
2626

2727
- **Admin interface > Events > Logs**: In the event list, click the arrow toggle next to the event you want to view.
2828

29-
## Viewing events in maps and charts :ak-enterprise :ak-version[2025.8]
29+
## Viewing events in maps and charts :ak-enterprise
3030

3131
With the enterprise version, you can view recent events on both a world map view with pinpoints indicating where each event occurred and also a color-coded chart that highlights event types and volume.
3232

3333
![](./event-map-chart.png)
34+
35+
## Advanced queries for event logs:ak-enterprise {#tell-me-more}
36+
37+
You can construct advanced queries, based on [DjangoQL](https://github.com/ivelum/djangoql), to find specific event logs. In the Admin interface, navigate to **Events > Logs**, and then use the auto-complete in the **Search** field or enter your own queries to return results with greater specificity.
38+
39+
- **Model/object**: `action`, `event_uuid`, `app`, `client_ip`, `user`, `brnad`, `context`, `created`
40+
41+
- **Operators**: `=`, `!=`, `~`, `!~`
42+
43+
- **Values**: `True`, `False`, `None`
44+
45+
- **Example queries**: `action = "login"`, `app startswith "N"`

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

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The following topics are for the basic management of users: how to create, modif
66

77
[Policies](../../customize/policies/index.md) can be used to further manage how users are authenticated. For example, by default authentik does not require email addresses be unique, but you can use a policy to [enforce unique email addresses](../../customize/policies/expression/unique_email.md).
88

9-
### Create a user
9+
## Create a user
1010

1111
> If you want to automate user creation, you can do that either by [invitations](./invitations.md), [`user_write` stage](../../add-secure-apps/flows-stages/stages/user_write.md), or [using the API](/api/reference/core-users-create).
1212
@@ -33,7 +33,33 @@ You should see a confirmation pop-up on the top-right of the screen that the use
3333
To create a super-user, you need to add the user to a group that has super-user permissions. For more information, refer to [Create a Group](../groups/manage_groups.mdx#create-a-group).
3434
:::
3535

36-
### View user details
36+
## Advanced queries for users:ak-enterprise {#tell-me-more}
37+
38+
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.
39+
40+
<!--| Model/Object | Operators | Examples |
41+
| ---- | ---- | ----------- |
42+
| `username` | `=` | `username = "Joel Bonne"` |
43+
| `path` | != | |
44+
| `name` | ~| |
45+
| `email` | !~ |
46+
| `path` | `startswith` |
47+
| `is_active` | `not startswith` |
48+
| `type` | `endswith` |
49+
| `attributes`| `endswith` |
50+
| | `not endswith` |
51+
| | `in` |
52+
| | `not in` |-->
53+
54+
- **Model/object**: `username`, `path`, `name`, `email`, `path`, `is_active`, `type`, `attributes`
55+
56+
- **Operators**: `=`, `!=`, `~`, `!~`, `startswith`, `not startswith`, `endswidth`, `not endswith`, `in`, `not in`
57+
58+
- **Values**: `True`, `False`, `None`
59+
60+
- **Example queries**: `username = "Joel Bonne"`, `is_active = false`
61+
62+
## View user details
3763

3864
In the **Directory > Users** menu of the Admin interface, you can browse all the users in your authentik instance.
3965

@@ -58,7 +84,7 @@ After the creation of the user, you can edit any parameter defined during the cr
5884

5985
To modify a user object, go to **Directory > Users**, and click the edit icon beside the name. You can also go into [user details](#view-user-details), and click **Edit**.
6086

61-
### Assign, modify, or remove permissions for a user
87+
## Assign, modify, or remove permissions for a user
6288

6389
You can grant a user specific global or object-level permissions. Alternatively, you can add a user to a group that has the appropriate permissions, and the user inherits all of the group's permissions.
6490

@@ -86,7 +112,7 @@ This option is only available if a default recovery flow was configured for the
86112

87113
A pop-up will appear on your browser with the link for you to copy and to send to the user.
88114

89-
### Email them a recovery link
115+
### Email a recovery link
90116

91117
:::info
92118
This option is only available if a default recovery flow was configured for the currently active brand and if the configured flow has an [Email Stage](../../add-secure-apps/flows-stages/stages/email/index.mdx) bound to it.
@@ -100,7 +126,7 @@ You can send a link with the URL for the user to reset their password via Email.
100126

101127
If the user does not receive the email, check if the mail server parameters [are properly configured](../../troubleshooting/emails.md).
102128

103-
### Reset the password for the user
129+
## Reset the password for the user
104130

105131
As an Admin, you can simply reset the password for the user.
106132

@@ -110,14 +136,14 @@ As an Admin, you can simply reset the password for the user.
110136

111137
## Deactivate or Delete user
112138

113-
#### To deactivate a user:
139+
### To deactivate a user:
114140

115141
1. Go into the user list or detail, and click **Deactivate**.
116142
2. Review the changes and click **Update**.
117143

118144
The active sessions are revoked and the authentication of the user blocked. You can reactivate the account by following the same procedure.
119145

120-
#### To delete a user:
146+
### To delete a user:
121147

122148
:::caution
123149
This deletion is not reversible, so be sure you do not need to recover any identity data of the user.

0 commit comments

Comments
 (0)