Authentik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for authentik Root API

2 actions 2 updates phrasing extends openapi/authentik-root-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Authentik's API. It is a proposal applied on top of the contract, not a document Authentik publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/root/config/'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Root API
  version: 1.0.0
extends: openapi/authentik-root-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: 1
- target: $.paths['/root/config/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the public instance configuration
      effect: read
      questions:
      - What public configuration does my authentik instance expose to clients?
      - Can I check which capabilities and settings the server advertises before signing in?
      - Where do I read the error reporting and UI settings a frontend should load?
      instructions:
      - text: Fetch the public configuration options for this authentik instance.
      - text: Show me which capabilities the server reports in its public config.
      method: generated
      generated: '2026-09-26'