Authentik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for authentik Managed API

11 actions 11 updates phrasing extends openapi/authentik-managed-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 11

$.info
$.paths['/managed/blueprints/'].get
$.paths['/managed/blueprints/'].post
$.paths['/managed/blueprints/{instance_uuid}/'].get
$.paths['/managed/blueprints/{instance_uuid}/'].put
$.paths['/managed/blueprints/{instance_uuid}/'].delete
$.paths['/managed/blueprints/{instance_uuid}/'].patch
$.paths['/managed/blueprints/{instance_uuid}/apply/'].post
$.paths['/managed/blueprints/{instance_uuid}/used_by/'].get
$.paths['/managed/blueprints/available/'].get
$.paths['/managed/blueprints/import/'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Managed API
  version: 1.0.0
extends: openapi/authentik-managed-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: 10
- target: $.paths['/managed/blueprints/'].get
  update:
    x-apievangelist-phrasing:
      intent: List blueprint instances
      effect: read
      questions:
      - Which blueprint instances are configured in authentik?
      - Can I find a blueprint instance by its file path?
      instructions:
      - text: List all blueprint instances.
      - text: Show blueprint instances named {name}.
        slots:
          name: query.name
      - text: Find the blueprint instance for path {path}.
        slots:
          path: query.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a blueprint instance
      effect: write
      questions:
      - How do I register a blueprint so authentik applies it?
      - Can a new blueprint instance take inline content instead of a file path?
      instructions:
      - text: Create blueprint instance {name} from path {path}.
        slots:
          name: requestBody.name
          path: requestBody.path
      - text: Add blueprint instance {name} with inline content {content} and context {context}.
        slots:
          name: requestBody.name
          content: requestBody.content
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/{instance_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blueprint instance
      effect: read
      questions:
      - What path and context does a particular blueprint instance use?
      - Is this blueprint instance enabled?
      instructions:
      - text: Show blueprint instance {instance_uuid}.
        slots:
          instance_uuid: path.instance_uuid
      - text: Fetch the details of blueprint {instance_uuid}.
        slots:
          instance_uuid: path.instance_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/{instance_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a blueprint instance
      effect: write
      questions:
      - Can I overwrite all settings of a blueprint instance at once?
      - What must I resend to fully replace a blueprint instance?
      instructions:
      - text: Replace blueprint instance {instance_uuid} with name {name}.
        slots:
          instance_uuid: path.instance_uuid
          name: requestBody.name
      - text: Fully rewrite blueprint {instance_uuid} as {name} from path {path}, enabled {enabled}.
        slots:
          instance_uuid: path.instance_uuid
          name: requestBody.name
          path: requestBody.path
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/{instance_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blueprint instance
      effect: destructive
      questions:
      - How do I remove a blueprint instance?
      - Is deleting a blueprint instance permanent?
      instructions:
      - text: Delete blueprint instance {instance_uuid}.
        slots:
          instance_uuid: path.instance_uuid
      - text: Remove blueprint {instance_uuid}.
        slots:
          instance_uuid: path.instance_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/{instance_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change part of a blueprint instance
      effect: write
      questions:
      - Can I just disable a blueprint instance without deleting it?
      - Is it possible to only change the context values of a blueprint?
      instructions:
      - text: Only set enabled on blueprint {instance_uuid} to {enabled}.
        slots:
          instance_uuid: path.instance_uuid
          enabled: requestBody.enabled
      - text: Change just the context of blueprint instance {instance_uuid} to {context}.
        slots:
          instance_uuid: path.instance_uuid
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/{instance_uuid}/apply/'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a blueprint instance now
      effect: write
      questions:
      - How do I run a blueprint immediately instead of waiting for the schedule?
      - Can I re-apply an existing blueprint instance on demand?
      instructions:
      - text: Apply blueprint instance {instance_uuid} now.
        slots:
          instance_uuid: path.instance_uuid
      - text: Run blueprint {instance_uuid} immediately.
        slots:
          instance_uuid: path.instance_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/{instance_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a blueprint instance
      effect: read
      questions:
      - What objects reference a given blueprint instance?
      - Does anything depend on this blueprint?
      instructions:
      - text: Show what references blueprint instance {instance_uuid}.
        slots:
          instance_uuid: path.instance_uuid
      - text: List objects using blueprint {instance_uuid}.
        slots:
          instance_uuid: path.instance_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/available/'].get
  update:
    x-apievangelist-phrasing:
      intent: List available blueprint files
      effect: read
      questions:
      - What blueprint files are available on disk to instantiate?
      - Which bundled blueprints could I turn into instances?
      instructions:
      - text: List the available blueprint files.
      - text: Show blueprints that can be instantiated.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/managed/blueprints/import/'].post
  update:
    x-apievangelist-phrasing:
      intent: Import and apply a blueprint once
      effect: write
      questions:
      - How do I apply a blueprint YAML file one time without creating an instance?
      - Can I upload a .yaml blueprint and have it applied immediately?
      instructions:
      - text: Import blueprint file {file} and apply it once.
        slots:
          file: requestBody.file
      - text: Apply the blueprint at path {path} a single time with context {context}, no instance.
        slots:
          path: requestBody.path
          context: requestBody.context
      method: generated
      generated: '2026-09-26'