Authentik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for authentik Ssf API

4 actions 4 updates phrasing extends openapi/authentik-ssf-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 4

$.info
$.paths['/ssf/streams/'].get
$.paths['/ssf/streams/{uuid}/'].get
$.paths['/ssf/streams/{uuid}/'].delete

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 Ssf API
  version: 1.0.0
extends: openapi/authentik-ssf-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: 3
- target: $.paths['/ssf/streams/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Shared Signals Framework streams
      effect: read
      questions:
      - Which SSF event streams are currently registered in authentik?
      - Can I filter shared signals streams by delivery method or receiver endpoint URL?
      instructions:
      - text: List all SSF streams.
      - text: Show SSF streams delivering to endpoint {endpoint_url}.
        slots:
          endpoint_url: query.endpoint_url
      - text: List the shared signals streams for SSF provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ssf/streams/{uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SSF stream
      effect: read
      questions:
      - What delivery method and endpoint does a specific SSF stream use?
      - How can I look up the details of one shared signals stream by its ID?
      instructions:
      - text: Show the details of SSF stream {uuid}.
        slots:
          uuid: path.uuid
      - text: Get the configuration of shared signals stream {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ssf/streams/{uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSF stream
      effect: destructive
      questions:
      - Can I remove a shared signals stream a receiver no longer uses?
      - What happens when I delete an SSF stream from authentik?
      instructions:
      - text: Delete SSF stream {uuid}.
        slots:
          uuid: path.uuid
      - text: Stop and remove shared signals stream {uuid}.
        slots:
          uuid: path.uuid
      method: generated
      generated: '2026-09-26'