website/docs: Add improved akql docs#22693
Open
PeshekDotDev wants to merge 11 commits into
Open
Conversation
✅ Deploy Preview for authentik-integrations ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for authentik-storybook ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #22693 +/- ##
===========================================
- Coverage 93.30% 37.64% -55.66%
===========================================
Files 1033 1026 -7
Lines 60150 59652 -498
Branches 400 400
===========================================
- Hits 56120 22455 -33665
- Misses 4030 37197 +33167
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
dewi-tik
requested changes
May 28, 2026
| ### `AKQL` is now open source | ||
|
|
||
| The `AKQL` search query language was previously an enterprise-only feature for [querying logs](../../sys-mgmt/events/logging-events.mdx#advanced-queries) and [users](../../users-sources/user/user_basic_operations.md#advanced-queries). `AKQL` is now free for everyone to use, allowing searches based on specific attributes such as `context.geo.country = "Germany"`. | ||
| The `AKQL` search query language was previously an enterprise-only feature for [querying logs](../../sys-mgmt/events/logging-events.mdx#advanced-queries) and [users](../../users-sources/user/user_basic_operations.md#advanced-queries). `AKQL` is now free for everyone to use, allowing searches based on specific attributes such as `context.geo.country = "Germany"`. For the full syntax and a list of where you can use it, see the new [AKQL reference](../../sys-mgmt/akql.mdx). |
Contributor
There was a problem hiding this comment.
Suggested change
| The `AKQL` search query language was previously an enterprise-only feature for [querying logs](../../sys-mgmt/events/logging-events.mdx#advanced-queries) and [users](../../users-sources/user/user_basic_operations.md#advanced-queries). `AKQL` is now free for everyone to use, allowing searches based on specific attributes such as `context.geo.country = "Germany"`. For the full syntax and a list of where you can use it, see the new [AKQL reference](../../sys-mgmt/akql.mdx). | |
| The `AKQL` search query language was previously an enterprise-only feature for [querying logs](../../sys-mgmt/events/logging-events.mdx#advanced-queries) and [users](../../users-sources/user/user_basic_operations.md#advanced-queries). `AKQL` is now free for everyone to use, allowing searches based on specific attributes such as `context.geo.country = "Germany"`. For the full syntax and a list of where you can use it, see the [AKQL reference](../../sys-mgmt/akql.mdx). |
|
|
||
| import { KeyBindingsTable } from "@goauthentik/docusaurus-theme/components/KeyBindingsTable"; | ||
|
|
||
| **AKQL** (authentik Query Language) is the advanced search syntax used throughout the authentik Admin interface. It lets you filter long lists, such as events, users, and groups, by writing structured expressions like `action = "login"` or `context.geo.country = "Germany"` instead of relying on a single free-text search. |
Contributor
There was a problem hiding this comment.
Need to standardize on either "list" or "area" throughout the doc
|
|
||
| ### Operators | ||
|
|
||
| The operator that's valid for a given comparison depends on the [type of the field](#field-types). The full set of operators is: |
Contributor
There was a problem hiding this comment.
Suggested change
| The operator that's valid for a given comparison depends on the [type of the field](#field-types). The full set of operators is: | |
| The operator that is valid for a given comparison depends on the [type of the field](#field-types). The full set of operators is: |
Contributor
Author
There was a problem hiding this comment.
I think this area was removed
Contributor
|
My suggested changes are still applicable despite showing as outdated |
PeshekDotDev
commented
May 28, 2026
Signed-off-by: Connor Peshek <connor@connorpeshek.me>
Co-authored-by: Dewi Roberts <dewi@goauthentik.io> Signed-off-by: Connor Peshek <connor@connorpeshek.me>
dominic-r
reviewed
May 28, 2026
dewi-tik
approved these changes
Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Details
Closes #22274
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen)If changes to the frontend have been made
make web)If applicable
make docs)