# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for authentik Admin API version: 1.0.0 extends: openapi/authentik-admin-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 14 - target: $.paths['/admin/apps/'].get update: x-apievangelist-phrasing: intent: List the installed apps effect: read questions: - Which Django apps are installed in my authentik server? - Can I see every app module that is loaded in this instance? instructions: - text: List all installed apps on this authentik server. - text: Show me the app modules loaded in the instance. method: generated generated: '2026-09-26' - target: $.paths['/admin/file/'].get update: x-apievangelist-phrasing: intent: List files in the storage backend effect: read questions: - What files have been uploaded to authentik's storage backend? - Can I list only the stored files I am allowed to manage, filtered by usage? instructions: - text: List stored files whose name matches {search}. slots: search: query.search - text: Show the uploaded files with usage {usage}, manageable ones only. slots: usage: query.usage method: generated generated: '2026-09-26' - target: $.paths['/admin/file/'].post update: x-apievangelist-phrasing: intent: Upload a file to storage effect: write questions: - How do I upload a logo or background image into authentik's file storage? - Can I give an uploaded file a custom name and usage type? instructions: - text: Upload {file} to the storage backend. slots: file: requestBody.file - text: Upload {file} named {name} for usage {usage}. slots: file: requestBody.file name: requestBody.name usage: requestBody.usage method: generated generated: '2026-09-26' - target: $.paths['/admin/file/'].delete update: x-apievangelist-phrasing: intent: Delete a file from storage effect: destructive questions: - Can I remove an uploaded file from authentik's storage backend? - What happens if I delete a stored media file by its name? instructions: - text: Delete the stored file {name} from the storage backend. slots: name: query.name - text: Remove file {name} with usage {usage} from storage. slots: name: query.name usage: query.usage method: generated generated: '2026-09-26' - target: $.paths['/admin/file/used_by/'].get update: x-apievangelist-phrasing: intent: See what uses a stored file effect: read questions: - Which objects still reference an uploaded file before I delete it? - Is a stored image in use by any brand, flow or application? instructions: - text: Show everything that uses the stored file {name}. slots: name: query.name - text: List the objects referencing uploaded file {name}. slots: name: query.name method: generated generated: '2026-09-26' - target: $.paths['/admin/models/'].get update: x-apievangelist-phrasing: intent: List the installed models effect: read questions: - Which data models are installed in my authentik instance? - Can I list only the models that support custom attributes? instructions: - text: List all installed models. - text: List installed models filtered by has-attributes = {filter_has_attributes}. slots: filter_has_attributes: query.filter_has_attributes method: generated generated: '2026-09-26' - target: $.paths['/admin/settings/'].get update: x-apievangelist-phrasing: intent: Get the system settings effect: read questions: - What are the current global settings on my authentik instance? - Where can I see the event retention and impersonation settings? instructions: - text: Show the current system settings. - text: Read the global settings, including avatars and token defaults. method: generated generated: '2026-09-26' - target: $.paths['/admin/settings/'].put update: x-apievangelist-phrasing: intent: Replace the system settings effect: write questions: - Can I overwrite the full set of global settings, feature flags included, in one call? - How do I replace all of authentik's system settings at once? instructions: - text: Replace the system settings with flags {flags} and base URL {base_url}. slots: flags: requestBody.flags base_url: requestBody.base_url - text: Overwrite all settings, setting event retention to {event_retention} and flags {flags}. slots: event_retention: requestBody.event_retention flags: requestBody.flags method: generated generated: '2026-09-26' - target: $.paths['/admin/settings/'].patch update: x-apievangelist-phrasing: intent: Change individual system settings effect: write questions: - Can I change just the default token duration without touching other settings? - Is it possible to require a reason for impersonation by editing one setting? instructions: - text: Set only the default token duration to {default_token_duration}. slots: default_token_duration: requestBody.default_token_duration - text: Turn impersonation-requires-reason to {impersonation_require_reason}, leaving other settings as is. slots: impersonation_require_reason: requestBody.impersonation_require_reason - text: Change just the pagination max page size to {pagination_max_page_size}. slots: pagination_max_page_size: requestBody.pagination_max_page_size method: generated generated: '2026-09-26' - target: $.paths['/admin/system/'].get update: x-apievangelist-phrasing: intent: Get system information effect: read questions: - What runtime and environment details does my authentik server report? - Can I see the server's system information page as data? instructions: - text: Get the system information for this server. - text: Fetch the runtime and environment details of the instance. method: generated generated: '2026-09-26' - target: $.paths['/admin/system/'].post update: x-apievangelist-phrasing: intent: Get system information via POST effect: read questions: - Is there a POST variant of the system information endpoint? - Can I request system information with a POST call instead of GET? instructions: - text: Request system information using the POST variant of the endpoint. - text: Post to the system endpoint to retrieve server details. method: generated generated: '2026-09-26' - target: $.paths['/admin/version/'].get update: x-apievangelist-phrasing: intent: Check running and latest version effect: read questions: - Which authentik version am I running, and is a newer one out? - Is my server outdated compared to the latest release? instructions: - text: Show the running version and the latest available version. - text: Check whether this instance needs an upgrade. method: generated generated: '2026-09-26' - target: $.paths['/admin/version/history/'].get update: x-apievangelist-phrasing: intent: List the version upgrade history effect: read questions: - What versions has this instance run over time? - Can I filter the version history by build or version number? instructions: - text: List the version history of this instance. - text: Show version history entries for version {version}. slots: version: query.version method: generated generated: '2026-09-26' - target: $.paths['/admin/version/history/{id}/'].get update: x-apievangelist-phrasing: intent: Get one version history entry effect: read questions: - When was a specific version history record logged? - Can I look up a single upgrade record by its id? instructions: - text: Get version history entry {id}. slots: id: path.id - text: Show the details of upgrade record {id}. slots: id: path.id method: generated generated: '2026-09-26'