Authentik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for authentik Sources API

174 actions 174 updates phrasing extends openapi/authentik-sources-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 174 · first 16 shown; the file carries all of them

$.info
$.paths['/sources/all/'].get
$.paths['/sources/all/{slug}/'].get
$.paths['/sources/all/{slug}/'].delete
$.paths['/sources/all/{slug}/used_by/'].get
$.paths['/sources/all/types/'].get
$.paths['/sources/all/user_settings/'].get
$.paths['/sources/group_connections/all/'].get
$.paths['/sources/group_connections/all/{id}/'].get
$.paths['/sources/group_connections/all/{id}/'].put
$.paths['/sources/group_connections/all/{id}/'].delete
$.paths['/sources/group_connections/all/{id}/'].patch
$.paths['/sources/group_connections/all/{id}/used_by/'].get
$.paths['/sources/group_connections/kerberos/'].get
$.paths['/sources/group_connections/kerberos/'].post
$.paths['/sources/group_connections/kerberos/{id}/'].get

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 Sources API
  version: 1.0.0
extends: openapi/authentik-sources-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: 173
- target: $.paths['/sources/all/'].get
  update:
    x-apievangelist-phrasing:
      intent: List all federation and sync sources
      effect: read
      questions:
      - Which login and directory sources are set up in authentik across every type?
      - Can I filter the combined source list down to only managed, built-in sources?
      instructions:
      - text: List every source regardless of type.
      - text: Search all sources for {search}.
        slots:
          search: query.search
      - text: Show only sources whose managed flag is {managed}.
        slots:
          managed: query.managed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/all/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get any source by its slug
      effect: read
      questions:
      - What type of source is behind a given slug, whatever protocol it uses?
      - Can I look up a source's generic details without knowing if it's LDAP, SAML or OAuth?
      instructions:
      - text: Show the source with slug {slug}.
        slots:
          slug: path.slug
      - text: Look up generic source {slug} and tell me its component type.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/all/{slug}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a source of any type
      effect: destructive
      questions:
      - Can built-in sources be deleted, or only ones I created?
      - What's the generic way to remove a source without going through its type-specific endpoint?
      instructions:
      - text: Delete source {slug} through the all-sources endpoint.
        slots:
          slug: path.slug
      - text: Remove the non-built-in source {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/all/{slug}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what depends on a source
      effect: read
      questions:
      - Which objects still reference a source before I delete it?
      - What would break if I removed a particular source, regardless of its type?
      instructions:
      - text: List everything that uses source {slug}.
        slots:
          slug: path.slug
      - text: Check dependents of source {slug} via the generic sources endpoint.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/all/types/'].get
  update:
    x-apievangelist-phrasing:
      intent: List source types that can be created
      effect: read
      questions:
      - What kinds of sources can I create in authentik?
      - Which source protocols are available to add as a new source?
      instructions:
      - text: List all creatable source types.
      - text: Show me the source type catalog I can pick from when adding a source.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/all/user_settings/'].get
  update:
    x-apievangelist-phrasing:
      intent: List sources the current user can configure
      effect: read
      questions:
      - Which sources can I, as a signed-in user, connect or configure on my own account?
      - What sources show up in a user's personal settings page?
      instructions:
      - text: List the sources I can configure from my user settings.
      - text: Show which sources the current user is allowed to link to their account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/all/'].get
  update:
    x-apievangelist-phrasing:
      intent: List group-source connections of every type
      effect: read
      questions:
      - Which authentik groups are linked to groups in external sources, across all source types?
      - Can I find every group connection coming from one source slug?
      instructions:
      - text: List all group-source connections.
      - text: Show group connections of every source type for source {source_slug}.
        slots:
          source_slug: query.source__slug
      - text: Find group connections of any type for group {group}.
        slots:
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/all/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group-source connection of any type
      effect: read
      questions:
      - What external identifier is a particular group connection mapped to, whatever its source type?
      - Is there a way to read one group connection without knowing which source type it belongs to?
      instructions:
      - text: Show group-source connection {id} from the all-types endpoint.
        slots:
          id: path.id
      - text: Get the identifier stored on generic group connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/all/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a group-source connection of any type
      effect: write
      questions:
      - Can I fully overwrite a group connection's source and identifier through the generic endpoint?
      - What's required to replace an existing group link regardless of its source type?
      instructions:
      - text: Replace generic group connection {id} with source {source} and identifier {identifier}.
        slots:
          id: path.id
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Overwrite all fields of group connection {id} via the all-types endpoint, identifier {identifier}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/all/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group-source connection of any type
      effect: destructive
      questions:
      - How can I unlink a group from an external source without knowing the source type?
      - Does removing a group connection through the generic endpoint delete the group itself?
      instructions:
      - text: Delete group-source connection {id} via the all-types endpoint.
        slots:
          id: path.id
      - text: Unlink generic group connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/all/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a group-source connection of any type
      effect: write
      questions:
      - Can I change only the external identifier on a group link without resending everything?
      - Is it possible to patch a group connection through the endpoint that covers all source types?
      instructions:
      - text: Change just the identifier on generic group connection {id} to {identifier}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      - text: Patch group connection {id} (any type) to point at source {source}.
        slots:
          id: path.id
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/all/{id}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a group-source connection of any type
      effect: read
      questions:
      - Which objects reference a given group connection, whatever its source type?
      - Before unlinking a group via the generic endpoint, what depends on that link?
      instructions:
      - text: List dependents of generic group connection {id}.
        slots:
          id: path.id
      - text: Show what uses group-source connection {id} across source types.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kerberos group connections
      effect: read
      questions:
      - Which groups are linked to a Kerberos realm source?
      - Can I list Kerberos group links for just one group?
      instructions:
      - text: List Kerberos group connections.
      - text: Show Kerberos group links for group {group}.
        slots:
          group: query.group
      - text: Find Kerberos group connections on source {source_slug}.
        slots:
          source_slug: query.source__slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a group to a Kerberos source
      effect: write
      questions:
      - How do I map an authentik group to a group from a Kerberos source?
      - What identifier does a new Kerberos group connection need?
      instructions:
      - text: Link Kerberos source {source} to a group with identifier {identifier}.
        slots:
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Create a Kerberos group connection for identifier {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Kerberos group connection
      effect: read
      questions:
      - What does a single Kerberos group link point to?
      - Can I see which Kerberos source a specific group connection came from?
      instructions:
      - text: Show Kerberos group connection {id}.
        slots:
          id: path.id
      - text: Get the Kerberos identifier on group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Kerberos group connection
      effect: write
      questions:
      - Can I overwrite a Kerberos group link with a new source and identifier?
      - What fields must I send to fully replace a Kerberos group connection?
      instructions:
      - text: Replace Kerberos group connection {id} with source {source} and identifier {identifier}.
        slots:
          id: path.id
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Overwrite Kerberos group link {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Kerberos group connection
      effect: destructive
      questions:
      - Can I unlink a group from its Kerberos source?
      - What happens when a Kerberos group connection is removed?
      instructions:
      - text: Delete Kerberos group connection {id}.
        slots:
          id: path.id
      - text: Unlink the Kerberos group mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a Kerberos group connection
      effect: write
      questions:
      - Is there a way to change only the identifier of a Kerberos group link?
      - Can I point an existing Kerberos group connection at another Kerberos source?
      instructions:
      - text: Set identifier {identifier} on Kerberos group connection {id}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      - text: Move Kerberos group link {id} to source {source}.
        slots:
          id: path.id
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/kerberos/{id}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a Kerberos group connection
      effect: read
      questions:
      - What references a Kerberos group connection?
      - Is anything depending on this Kerberos group link before I delete it?
      instructions:
      - text: List objects that use Kerberos group connection {id}.
        slots:
          id: path.id
      - text: Check dependents of Kerberos group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/'].get
  update:
    x-apievangelist-phrasing:
      intent: List LDAP group connections
      effect: read
      questions:
      - Which authentik groups were synced from an LDAP directory?
      - Can I search the LDAP group connections by name?
      instructions:
      - text: List LDAP group connections.
      - text: Search LDAP group links for {search}.
        slots:
          search: query.search
      - text: Show LDAP group connections from source {source_slug}.
        slots:
          source_slug: query.source__slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a group to a LDAP source
      effect: write
      questions:
      - How do I tie an authentik group to an LDAP group by its DN or unique ID?
      - What's needed to create a new LDAP group connection by hand?
      instructions:
      - text: Link LDAP source {source} to a group using identifier {identifier}.
        slots:
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Create an LDAP group connection with identifier {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a LDAP group connection
      effect: read
      questions:
      - Which LDAP object is a given group connection tied to?
      - Can I read the LDAP identifier stored on one group link?
      instructions:
      - text: Show LDAP group connection {id}.
        slots:
          id: path.id
      - text: Get the LDAP source behind group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a LDAP group connection
      effect: write
      questions:
      - Can I fully replace an LDAP group connection's source and identifier?
      - What does a full overwrite of an LDAP group link require?
      instructions:
      - text: Replace LDAP group connection {id} with source {source} and identifier {identifier}.
        slots:
          id: path.id
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Overwrite LDAP group link {id} with identifier {identifier}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a LDAP group connection
      effect: destructive
      questions:
      - Can I disconnect a group from its LDAP directory entry?
      - Will deleting an LDAP group connection stop that group syncing?
      instructions:
      - text: Delete LDAP group connection {id}.
        slots:
          id: path.id
      - text: Unlink the group behind LDAP connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a LDAP group connection
      effect: write
      questions:
      - Can I update only the identifier on an LDAP group link?
      - Is there a partial update for LDAP group connections?
      instructions:
      - text: Change the identifier of LDAP group connection {id} to {identifier}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      - text: Reassign LDAP group link {id} to source {source}.
        slots:
          id: path.id
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/ldap/{id}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a LDAP group connection
      effect: read
      questions:
      - What objects depend on an LDAP group connection?
      - Is an LDAP group link referenced anywhere else?
      instructions:
      - text: List dependents of LDAP group connection {id}.
        slots:
          id: path.id
      - text: Show what uses LDAP group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth group connections
      effect: read
      questions:
      - Which groups came in from an OAuth or OpenID Connect source?
      - Can I filter OAuth group connections to a single group?
      instructions:
      - text: List OAuth group connections.
      - text: Show OAuth group links for group {group}.
        slots:
          group: query.group
      - text: Find OAuth group connections from source {source_slug}.
        slots:
          source_slug: query.source__slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a group to a OAuth source
      effect: write
      questions:
      - How do I link an authentik group to a group claim from an OAuth source?
      - What does a new OAuth group connection need as its identifier?
      instructions:
      - text: Link OAuth source {source} to a group with identifier {identifier}.
        slots:
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Create an OAuth group connection for claim value {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a OAuth group connection
      effect: read
      questions:
      - What group identifier is stored on a single OAuth group link?
      - Which OAuth source does one group connection belong to?
      instructions:
      - text: Show OAuth group connection {id}.
        slots:
          id: path.id
      - text: Get the OAuth source and identifier for group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a OAuth group connection
      effect: write
      questions:
      - Can I overwrite an OAuth group connection completely?
      - What must I send to replace an OAuth group link?
      instructions:
      - text: Replace OAuth group connection {id} with source {source} and identifier {identifier}.
        slots:
          id: path.id
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Fully overwrite OAuth group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a OAuth group connection
      effect: destructive
      questions:
      - Can I remove the link between a group and an OAuth source?
      - What happens to the group when an OAuth group connection is deleted?
      instructions:
      - text: Delete OAuth group connection {id}.
        slots:
          id: path.id
      - text: Unlink OAuth group mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a OAuth group connection
      effect: write
      questions:
      - Is it possible to change only the identifier of an OAuth group link?
      - Can I switch an OAuth group connection to a different OAuth source?
      instructions:
      - text: Update the identifier on OAuth group connection {id} to {identifier}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      - text: Point OAuth group link {id} at source {source}.
        slots:
          id: path.id
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/oauth/{id}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a OAuth group connection
      effect: read
      questions:
      - What references an OAuth group connection?
      - Does anything rely on this OAuth group link?
      instructions:
      - text: List objects using OAuth group connection {id}.
        slots:
          id: path.id
      - text: Check what depends on OAuth group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Plex group connections
      effect: read
      questions:
      - Which groups are linked to a Plex source?
      - Can I search Plex group connections?
      instructions:
      - text: List Plex group connections.
      - text: Search Plex group links for {search}.
        slots:
          search: query.search
      - text: Show Plex group connections for group {group}.
        slots:
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a group to a Plex source
      effect: write
      questions:
      - How do I attach an authentik group to a Plex source?
      - What identifier does a Plex group connection take?
      instructions:
      - text: Link Plex source {source} to a group with identifier {identifier}.
        slots:
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Create a Plex group connection using identifier {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Plex group connection
      effect: read
      questions:
      - What's stored on a single Plex group link?
      - Which Plex source is one group connection tied to?
      instructions:
      - text: Show Plex group connection {id}.
        slots:
          id: path.id
      - text: Get the identifier of Plex group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Plex group connection
      effect: write
      questions:
      - Can I fully replace a Plex group connection?
      - Which fields are required to overwrite a Plex group link?
      instructions:
      - text: Replace Plex group connection {id} with source {source} and identifier {identifier}.
        slots:
          id: path.id
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Overwrite Plex group link {id} completely.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Plex group connection
      effect: destructive
      questions:
      - Can I unlink a group from a Plex source?
      - Is deleting a Plex group connection reversible?
      instructions:
      - text: Delete Plex group connection {id}.
        slots:
          id: path.id
      - text: Remove the Plex group mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a Plex group connection
      effect: write
      questions:
      - Can I edit just the identifier on a Plex group link?
      - Is there a way to move a Plex group connection to another Plex source?
      instructions:
      - text: Set identifier {identifier} on Plex group connection {id}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      - text: Reassign Plex group link {id} to source {source}.
        slots:
          id: path.id
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/plex/{id}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a Plex group connection
      effect: read
      questions:
      - What depends on a Plex group connection?
      - Is a Plex group link referenced by other objects?
      instructions:
      - text: List dependents of Plex group connection {id}.
        slots:
          id: path.id
      - text: Show what uses Plex group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML group connections
      effect: read
      questions:
      - Which groups were mapped in from a SAML identity provider?
      - Can I list SAML group connections for one SAML source?
      instructions:
      - text: List SAML group connections.
      - text: Show SAML group links from source {source_slug}.
        slots:
          source_slug: query.source__slug
      - text: Find SAML group connections for group {group}.
        slots:
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a group to a SAML source
      effect: write
      questions:
      - How do I map an authentik group to a group attribute from a SAML source?
      - What identifier does a new SAML group connection expect?
      instructions:
      - text: Link SAML source {source} to a group with identifier {identifier}.
        slots:
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Create a SAML group connection for attribute value {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAML group connection
      effect: read
      questions:
      - What SAML group value is a specific group connection mapped to?
      - Which SAML source owns one group link?
      instructions:
      - text: Show SAML group connection {id}.
        slots:
          id: path.id
      - text: Get the SAML identifier on group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SAML group connection
      effect: write
      questions:
      - Can I replace a SAML group connection's source and identifier together?
      - What's needed for a full overwrite of a SAML group link?
      instructions:
      - text: Replace SAML group connection {id} with source {source} and identifier {identifier}.
        slots:
          id: path.id
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Overwrite SAML group link {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML group connection
      effect: destructive
      questions:
      - Can I disconnect a group from its SAML identity provider mapping?
      - What happens when a SAML group connection is deleted?
      instructions:
      - text: Delete SAML group connection {id}.
        slots:
          id: path.id
      - text: Unlink SAML group mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit part of a SAML group connection
      effect: write
      questions:
      - Can I change only the identifier on a SAML group link?
      - Is there a partial update for SAML group connections?
      instructions:
      - text: Change the identifier on SAML group connection {id} to {identifier}.
        slots:
          id: path.id
          identifier: requestBody.identifier
      - text: Point SAML group link {id} to source {source}.
        slots:
          id: path.id
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/saml/{id}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what uses a SAML group connection
      effect: read
      questions:
      - What references a SAML group connection?
      - Is anything relying on a SAML group link I want to remove?
      instructions:
      - text: List objects using SAML group connection {id}.
        slots:
          id: path.id
      - text: Check dependents of SAML group link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/telegram/'].get
  update:
    x-apievangelist-phrasing:
      intent: List Telegram group connections
      effect: read
      questions:
      - Which groups are linked to a Telegram source?
      - Can I search Telegram group connections?
      instructions:
      - text: List Telegram group connections.
      - text: Search Telegram group links for {search}.
        slots:
          search: query.search
      - text: Show Telegram group connections from source {source_slug}.
        slots:
          source_slug: query.source__slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sources/group_connections/telegram/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a group to a Telegram source
      effect: write
      questions:
      - How do I link an authentik group to a Telegram source?
      - What identifier does a Telegram group connection need?
      instructions:
      - text: Link Telegram source {source} to a group with identifier {identifier}.
        slots:
          source: requestBody.source
          identifier: requestBody.identifier
      - text: Create a Telegram group connection with identifier {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/overlays/authentik-sources-api-phrasing-overlay.yaml