Authentik

Authentik Sources API

External identity sources — LDAP, OAuth, SAML, SCIM, Kerberos, Plex and Telegram — plus their user and group connections.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 173

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /sources/all/ List all federation and sync sources · Sources all list #
Ask an LLM
“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?”
Tell an agent
List every source regardless of type.
Search all sources for {search}.
GET /sources/all/{slug}/ Get any source by its slug · Sources all retrieve #
Ask an LLM
“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?”
Tell an agent
Show the source with slug {slug}.
Look up generic source {slug} and tell me its component type.
DELETE /sources/all/{slug}/ Delete a source of any type · Sources all destroy #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete source {slug} through the all-sources endpoint.
Remove the non-built-in source {slug}.
GET /sources/all/{slug}/used_by/ See what depends on a source · Sources all used by list #
Ask an LLM
“Which objects still reference a source before I delete it?”
“What would break if I removed a particular source, regardless of its type?”
Tell an agent
List everything that uses source {slug}.
Check dependents of source {slug} via the generic sources endpoint.
GET /sources/all/types/ List source types that can be created · Sources all types list #
Ask an LLM
“What kinds of sources can I create in authentik?”
“Which source protocols are available to add as a new source?”
Tell an agent
List all creatable source types.
Show me the source type catalog I can pick from when adding a source.
GET /sources/all/user_settings/ List sources the current user can configure · Sources all user settings list #
Ask an LLM
“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?”
Tell an agent
List the sources I can configure from my user settings.
Show which sources the current user is allowed to link to their account.
GET /sources/group_connections/all/ List group-source connections of every type · Sources group connections all list #
Ask an LLM
“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?”
Tell an agent
List all group-source connections.
Show group connections of every source type for source {source_slug}.
GET /sources/group_connections/all/{id}/ Get a group-source connection of any type · Sources group connections all retrieve #
Ask an LLM
“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?”
Tell an agent
Show group-source connection {id} from the all-types endpoint.
Get the identifier stored on generic group connection {id}.
PUT /sources/group_connections/all/{id}/ Replace a group-source connection of any type · Sources group connections all update #
Ask an LLM
“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?”
Tell an agent
Replace generic group connection {id} with source {source} and identifier {identifier}.
Overwrite all fields of group connection {id} via the all-types endpoint, identifier {identifier}.
PATCH /sources/group_connections/all/{id}/ Edit part of a group-source connection of any type · Sources group connections all partial update #
Ask an LLM
“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?”
Tell an agent
Change just the identifier on generic group connection {id} to {identifier}.
Patch group connection {id} (any type) to point at source {source}.
DELETE /sources/group_connections/all/{id}/ Delete a group-source connection of any type · Sources group connections all destroy #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete group-source connection {id} via the all-types endpoint.
Unlink generic group connection {id}.
GET /sources/group_connections/all/{id}/used_by/ See what uses a group-source connection of any type · Sources group connections all used by list #
Ask an LLM
“Which objects reference a given group connection, whatever its source type?”
“Before unlinking a group via the generic endpoint, what depends on that link?”
Tell an agent
List dependents of generic group connection {id}.
Show what uses group-source connection {id} across source types.
GET /sources/group_connections/kerberos/ List Kerberos group connections · Sources group connections kerberos list #
Ask an LLM
“Which groups are linked to a Kerberos realm source?”
“Can I list Kerberos group links for just one group?”
Tell an agent
List Kerberos group connections.
Show Kerberos group links for group {group}.
POST /sources/group_connections/kerberos/ Link a group to a Kerberos source · Sources group connections kerberos create #
Ask an LLM
“How do I map an authentik group to a group from a Kerberos source?”
“What identifier does a new Kerberos group connection need?”
Tell an agent
Link Kerberos source {source} to a group with identifier {identifier}.
Create a Kerberos group connection for identifier {identifier}.
GET /sources/group_connections/kerberos/{id}/ Get a Kerberos group connection · Sources group connections kerberos retrieve #
Ask an LLM
“What does a single Kerberos group link point to?”
“Can I see which Kerberos source a specific group connection came from?”
Tell an agent
Show Kerberos group connection {id}.
Get the Kerberos identifier on group link {id}.
PUT /sources/group_connections/kerberos/{id}/ Replace a Kerberos group connection · Sources group connections kerberos update #
Ask an LLM
“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?”
Tell an agent
Replace Kerberos group connection {id} with source {source} and identifier {identifier}.
Overwrite Kerberos group link {id} entirely.
PATCH /sources/group_connections/kerberos/{id}/ Edit part of a Kerberos group connection · Sources group connections kerberos partial update #
Ask an LLM
“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?”
Tell an agent
Set identifier {identifier} on Kerberos group connection {id}.
Move Kerberos group link {id} to source {source}.
DELETE /sources/group_connections/kerberos/{id}/ Delete a Kerberos group connection · Sources group connections kerberos destroy #
Ask an LLM
“Can I unlink a group from its Kerberos source?”
“What happens when a Kerberos group connection is removed?”
Tell an agent destructive · confirm first
Delete Kerberos group connection {id}.
Unlink the Kerberos group mapping {id}.
GET /sources/group_connections/kerberos/{id}/used_by/ See what uses a Kerberos group connection · Sources group connections kerberos used by list #
Ask an LLM
“What references a Kerberos group connection?”
“Is anything depending on this Kerberos group link before I delete it?”
Tell an agent
List objects that use Kerberos group connection {id}.
Check dependents of Kerberos group link {id}.
GET /sources/group_connections/ldap/ List LDAP group connections · Sources group connections ldap list #
Ask an LLM
“Which authentik groups were synced from an LDAP directory?”
“Can I search the LDAP group connections by name?”
Tell an agent
List LDAP group connections.
Search LDAP group links for {search}.
POST /sources/group_connections/ldap/ Link a group to a LDAP source · Sources group connections ldap create #
Ask an LLM
“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?”
Tell an agent
Link LDAP source {source} to a group using identifier {identifier}.
Create an LDAP group connection with identifier {identifier}.
GET /sources/group_connections/ldap/{id}/ Get a LDAP group connection · Sources group connections ldap retrieve #
Ask an LLM
“Which LDAP object is a given group connection tied to?”
“Can I read the LDAP identifier stored on one group link?”
Tell an agent
Show LDAP group connection {id}.
Get the LDAP source behind group link {id}.
PUT /sources/group_connections/ldap/{id}/ Replace a LDAP group connection · Sources group connections ldap update #
Ask an LLM
“Can I fully replace an LDAP group connection's source and identifier?”
“What does a full overwrite of an LDAP group link require?”
Tell an agent
Replace LDAP group connection {id} with source {source} and identifier {identifier}.
Overwrite LDAP group link {id} with identifier {identifier}.
PATCH /sources/group_connections/ldap/{id}/ Edit part of a LDAP group connection · Sources group connections ldap partial update #
Ask an LLM
“Can I update only the identifier on an LDAP group link?”
“Is there a partial update for LDAP group connections?”
Tell an agent
Change the identifier of LDAP group connection {id} to {identifier}.
Reassign LDAP group link {id} to source {source}.
DELETE /sources/group_connections/ldap/{id}/ Delete a LDAP group connection · Sources group connections ldap destroy #
Ask an LLM
“Can I disconnect a group from its LDAP directory entry?”
“Will deleting an LDAP group connection stop that group syncing?”
Tell an agent destructive · confirm first
Delete LDAP group connection {id}.
Unlink the group behind LDAP connection {id}.
GET /sources/group_connections/ldap/{id}/used_by/ See what uses a LDAP group connection · Sources group connections ldap used by list #
Ask an LLM
“What objects depend on an LDAP group connection?”
“Is an LDAP group link referenced anywhere else?”
Tell an agent
List dependents of LDAP group connection {id}.
Show what uses LDAP group link {id}.
GET /sources/group_connections/oauth/ List OAuth group connections · Sources group connections oauth list #
Ask an LLM
“Which groups came in from an OAuth or OpenID Connect source?”
“Can I filter OAuth group connections to a single group?”
Tell an agent
List OAuth group connections.
Show OAuth group links for group {group}.
POST /sources/group_connections/oauth/ Link a group to a OAuth source · Sources group connections oauth create #
Ask an LLM
“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?”
Tell an agent
Link OAuth source {source} to a group with identifier {identifier}.
Create an OAuth group connection for claim value {identifier}.
GET /sources/group_connections/oauth/{id}/ Get a OAuth group connection · Sources group connections oauth retrieve #
Ask an LLM
“What group identifier is stored on a single OAuth group link?”
“Which OAuth source does one group connection belong to?”
Tell an agent
Show OAuth group connection {id}.
Get the OAuth source and identifier for group link {id}.
PUT /sources/group_connections/oauth/{id}/ Replace a OAuth group connection · Sources group connections oauth update #
Ask an LLM
“Can I overwrite an OAuth group connection completely?”
“What must I send to replace an OAuth group link?”
Tell an agent
Replace OAuth group connection {id} with source {source} and identifier {identifier}.
Fully overwrite OAuth group link {id}.
PATCH /sources/group_connections/oauth/{id}/ Edit part of a OAuth group connection · Sources group connections oauth partial update #
Ask an LLM
“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?”
Tell an agent
Update the identifier on OAuth group connection {id} to {identifier}.
Point OAuth group link {id} at source {source}.
DELETE /sources/group_connections/oauth/{id}/ Delete a OAuth group connection · Sources group connections oauth destroy #
Ask an LLM
“Can I remove the link between a group and an OAuth source?”
“What happens to the group when an OAuth group connection is deleted?”
Tell an agent destructive · confirm first
Delete OAuth group connection {id}.
Unlink OAuth group mapping {id}.
GET /sources/group_connections/oauth/{id}/used_by/ See what uses a OAuth group connection · Sources group connections oauth used by list #
Ask an LLM
“What references an OAuth group connection?”
“Does anything rely on this OAuth group link?”
Tell an agent
List objects using OAuth group connection {id}.
Check what depends on OAuth group link {id}.
GET /sources/group_connections/plex/ List Plex group connections · Sources group connections plex list #
Ask an LLM
“Which groups are linked to a Plex source?”
“Can I search Plex group connections?”
Tell an agent
List Plex group connections.
Search Plex group links for {search}.
POST /sources/group_connections/plex/ Link a group to a Plex source · Sources group connections plex create #
Ask an LLM
“How do I attach an authentik group to a Plex source?”
“What identifier does a Plex group connection take?”
Tell an agent
Link Plex source {source} to a group with identifier {identifier}.
Create a Plex group connection using identifier {identifier}.
GET /sources/group_connections/plex/{id}/ Get a Plex group connection · Sources group connections plex retrieve #
Ask an LLM
“What's stored on a single Plex group link?”
“Which Plex source is one group connection tied to?”
Tell an agent
Show Plex group connection {id}.
Get the identifier of Plex group link {id}.
PUT /sources/group_connections/plex/{id}/ Replace a Plex group connection · Sources group connections plex update #
Ask an LLM
“Can I fully replace a Plex group connection?”
“Which fields are required to overwrite a Plex group link?”
Tell an agent
Replace Plex group connection {id} with source {source} and identifier {identifier}.
Overwrite Plex group link {id} completely.
PATCH /sources/group_connections/plex/{id}/ Edit part of a Plex group connection · Sources group connections plex partial update #
Ask an LLM
“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?”
Tell an agent
Set identifier {identifier} on Plex group connection {id}.
Reassign Plex group link {id} to source {source}.
DELETE /sources/group_connections/plex/{id}/ Delete a Plex group connection · Sources group connections plex destroy #
Ask an LLM
“Can I unlink a group from a Plex source?”
“Is deleting a Plex group connection reversible?”
Tell an agent destructive · confirm first
Delete Plex group connection {id}.
Remove the Plex group mapping {id}.
GET /sources/group_connections/plex/{id}/used_by/ See what uses a Plex group connection · Sources group connections plex used by list #
Ask an LLM
“What depends on a Plex group connection?”
“Is a Plex group link referenced by other objects?”
Tell an agent
List dependents of Plex group connection {id}.
Show what uses Plex group link {id}.
GET /sources/group_connections/saml/ List SAML group connections · Sources group connections saml list #
Ask an LLM
“Which groups were mapped in from a SAML identity provider?”
“Can I list SAML group connections for one SAML source?”
Tell an agent
List SAML group connections.
Show SAML group links from source {source_slug}.
POST /sources/group_connections/saml/ Link a group to a SAML source · Sources group connections saml create #
Ask an LLM
“How do I map an authentik group to a group attribute from a SAML source?”
“What identifier does a new SAML group connection expect?”
Tell an agent
Link SAML source {source} to a group with identifier {identifier}.
Create a SAML group connection for attribute value {identifier}.
GET /sources/group_connections/saml/{id}/ Get a SAML group connection · Sources group connections saml retrieve #
Ask an LLM
“What SAML group value is a specific group connection mapped to?”
“Which SAML source owns one group link?”
Tell an agent
Show SAML group connection {id}.
Get the SAML identifier on group link {id}.
PUT /sources/group_connections/saml/{id}/ Replace a SAML group connection · Sources group connections saml update #
Ask an LLM
“Can I replace a SAML group connection's source and identifier together?”
“What's needed for a full overwrite of a SAML group link?”
Tell an agent
Replace SAML group connection {id} with source {source} and identifier {identifier}.
Overwrite SAML group link {id} in full.
PATCH /sources/group_connections/saml/{id}/ Edit part of a SAML group connection · Sources group connections saml partial update #
Ask an LLM
“Can I change only the identifier on a SAML group link?”
“Is there a partial update for SAML group connections?”
Tell an agent
Change the identifier on SAML group connection {id} to {identifier}.
Point SAML group link {id} to source {source}.
DELETE /sources/group_connections/saml/{id}/ Delete a SAML group connection · Sources group connections saml destroy #
Ask an LLM
“Can I disconnect a group from its SAML identity provider mapping?”
“What happens when a SAML group connection is deleted?”
Tell an agent destructive · confirm first
Delete SAML group connection {id}.
Unlink SAML group mapping {id}.
GET /sources/group_connections/saml/{id}/used_by/ See what uses a SAML group connection · Sources group connections saml used by list #
Ask an LLM
“What references a SAML group connection?”
“Is anything relying on a SAML group link I want to remove?”
Tell an agent
List objects using SAML group connection {id}.
Check dependents of SAML group link {id}.
GET /sources/group_connections/telegram/ List Telegram group connections · Sources group connections telegram list #
Ask an LLM
“Which groups are linked to a Telegram source?”
“Can I search Telegram group connections?”
Tell an agent
List Telegram group connections.
Search Telegram group links for {search}.
POST /sources/group_connections/telegram/ Link a group to a Telegram source · Sources group connections telegram create #
Ask an LLM
“How do I link an authentik group to a Telegram source?”
“What identifier does a Telegram group connection need?”
Tell an agent
Link Telegram source {source} to a group with identifier {identifier}.
Create a Telegram group connection with identifier {identifier}.
GET /sources/group_connections/telegram/{id}/ Get a Telegram group connection · Sources group connections telegram retrieve #
Ask an LLM
“What does one Telegram group link contain?”
“Which Telegram source is a specific group connection tied to?”
Tell an agent
Show Telegram group connection {id}.
Get the identifier on Telegram group link {id}.
PUT /sources/group_connections/telegram/{id}/ Replace a Telegram group connection · Sources group connections telegram update #
Ask an LLM
“Can I overwrite a Telegram group connection entirely?”
“What must I send to replace a Telegram group link?”
Tell an agent
Replace Telegram group connection {id} with source {source} and identifier {identifier}.
Fully overwrite Telegram group link {id}.
PATCH /sources/group_connections/telegram/{id}/ Edit part of a Telegram group connection · Sources group connections telegram partial update #
Ask an LLM
“Can I update only the identifier on a Telegram group link?”
“Is it possible to switch a Telegram group connection to another Telegram source?”
Tell an agent
Set identifier {identifier} on Telegram group connection {id}.
Move Telegram group link {id} to source {source}.
DELETE /sources/group_connections/telegram/{id}/ Delete a Telegram group connection · Sources group connections telegram destroy #
Ask an LLM
“Can I unlink a group from a Telegram source?”
“Does deleting a Telegram group connection affect the group's members?”
Tell an agent destructive · confirm first
Delete Telegram group connection {id}.
Remove Telegram group mapping {id}.
GET /sources/group_connections/telegram/{id}/used_by/ See what uses a Telegram group connection · Sources group connections telegram used by list #
Ask an LLM
“What depends on a Telegram group connection?”
“Is a Telegram group link referenced anywhere?”
Tell an agent
List dependents of Telegram group connection {id}.
Show what uses Telegram group link {id}.
GET /sources/kerberos/ List Kerberos sources · Sources kerberos list #
Ask an LLM
“Which Kerberos realms are connected to authentik as login sources?”
“Can I find Kerberos sources that sync users from a particular realm?”
Tell an agent
List all Kerberos sources.
Show Kerberos sources for realm {realm}.
POST /sources/kerberos/ Add a Kerberos source · Sources kerberos create #
Ask an LLM
“How do I connect a Kerberos realm to authentik for SPNEGO and password logins?”
“What's required to set up a new Kerberos source?”
Tell an agent
Create a Kerberos source {name} with slug {slug} for realm {realm}.
Add Kerberos source {name} (slug {slug}, realm {realm}) that syncs users using principal {sync_principal}.
GET /sources/kerberos/{slug}/ Get a Kerberos source · Sources kerberos retrieve #
Ask an LLM
“What realm and sync settings does a specific Kerberos source use?”
“Is SPNEGO configured on one of my Kerberos sources?”
Tell an agent
Show Kerberos source {slug}.
Get the realm and kadmin settings of Kerberos source {slug}.
PUT /sources/kerberos/{slug}/ Replace a Kerberos source's configuration · Sources kerberos update #
Ask an LLM
“Can I overwrite a Kerberos source's full configuration in one call?”
“Which fields are mandatory when replacing a Kerberos source?”
Tell an agent
Replace Kerberos source {slug} with name {name}, new slug {new_slug} and realm {realm}.
Fully reconfigure Kerberos source {slug} for realm {realm}.
PATCH /sources/kerberos/{slug}/ Change settings on a Kerberos source · Sources kerberos partial update #
Ask an LLM
“Can I just toggle user syncing on a Kerberos source without resending everything?”
“Is it possible to change only the SPNEGO server name of a Kerberos source?”
Tell an agent
Disable Kerberos source {slug} by setting enabled to {enabled}.
Set the SPNEGO server name on Kerberos source {slug} to {spnego_server_name}.
DELETE /sources/kerberos/{slug}/ Delete a Kerberos source · Sources kerberos destroy #
Ask an LLM
“How do I remove a Kerberos realm source from authentik?”
“What happens to users synced from a Kerberos source when I delete it?”
Tell an agent destructive · confirm first
Delete Kerberos source {slug}.
Remove the Kerberos realm source {slug} from authentik.
GET /sources/kerberos/{slug}/sync/status/ Check a Kerberos source's sync status · Sources kerberos sync status retrieve #
Ask an LLM
“Did the last Kerberos user sync finish, and when did it run?”
“Is a Kerberos source currently syncing?”
Tell an agent
Show sync status for Kerberos source {slug}.
Check whether Kerberos source {slug} is syncing right now.
GET /sources/kerberos/{slug}/used_by/ See what uses a Kerberos source · Sources kerberos used by list #
Ask an LLM
“Which flows or objects reference a Kerberos source?”
“What depends on a Kerberos source before I delete it?”
Tell an agent
List objects that use Kerberos source {slug}.
Check dependents of Kerberos source {slug}.
GET /sources/ldap/ List LDAP sources · Sources ldap list #
Ask an LLM
“Which LDAP or Active Directory servers are connected to authentik?”
“Can I find LDAP sources pointed at a specific server URI?”
Tell an agent
List all LDAP sources.
Show LDAP sources connected to {server_uri}.
POST /sources/ldap/ Add an LDAP source · Sources ldap create #
Ask an LLM
“How do I connect an Active Directory or LDAP server to authentik?”
“What settings are required to create an LDAP source?”
Tell an agent
Create LDAP source {name} with slug {slug} at {server_uri} using base DN {base_dn}.
Add LDAP source {name} (slug {slug}) at {server_uri}, base DN {base_dn}, binding as {bind_cn}.
GET /sources/ldap/{slug}/ Get an LDAP source · Sources ldap retrieve #
Ask an LLM
“What server, base DN and filters does a particular LDAP source use?”
“Is StartTLS turned on for one of my LDAP sources?”
Tell an agent
Show LDAP source {slug}.
Get the connection and filter settings of LDAP source {slug}.
PUT /sources/ldap/{slug}/ Replace an LDAP source's configuration · Sources ldap update #
Ask an LLM
“Can I overwrite an LDAP source's whole configuration at once?”
“Which fields must be supplied when fully replacing an LDAP source?”
Tell an agent
Replace LDAP source {slug} with name {name}, slug {new_slug}, server {server_uri} and base DN {base_dn}.
Fully reconfigure LDAP source {slug} to use server {server_uri}.
PATCH /sources/ldap/{slug}/ Change settings on an LDAP source · Sources ldap partial update #
Ask an LLM
“Can I rotate just the bind password on an LDAP source?”
“Is it possible to change only the user object filter of an LDAP source?”
Tell an agent
Set the bind password on LDAP source {slug} to {bind_password}.
Change the user object filter of LDAP source {slug} to {user_object_filter}.
DELETE /sources/ldap/{slug}/ Delete an LDAP source · Sources ldap destroy #
Ask an LLM
“How do I disconnect an LDAP directory from authentik?”
“Does deleting an LDAP source remove the users it synced?”
Tell an agent destructive · confirm first
Delete LDAP source {slug}.
Remove the LDAP directory source {slug}.
GET /sources/ldap/{slug}/debug/ Get raw LDAP data for debugging · Sources ldap debug retrieve #
Ask an LLM
“How can I see the raw LDAP data authentik pulls from my directory?”
“Can I debug why LDAP users aren't mapping correctly by inspecting the raw entries?”
Tell an agent
Fetch raw debug data from LDAP source {slug}.
Dump the raw LDAP entries for source {slug} so I can troubleshoot.
GET /sources/ldap/{slug}/sync/status/ Check an LDAP source's sync status · Sources ldap sync status retrieve #
Ask an LLM
“When did the last LDAP sync run, and did it succeed?”
“Is my LDAP directory sync still in progress?”
Tell an agent
Show sync status for LDAP source {slug}.
Check whether LDAP source {slug} is currently syncing.
GET /sources/ldap/{slug}/used_by/ See what uses an LDAP source · Sources ldap used by list #
Ask an LLM
“Which objects reference an LDAP source?”
“What would be affected if I removed an LDAP source?”
Tell an agent
List objects that use LDAP source {slug}.
Check dependents of LDAP source {slug}.
GET /sources/oauth/ List OAuth sources · Sources oauth list #
Ask an LLM
“Which social login and OpenID Connect sources are configured in authentik?”
“Can I list only the OAuth sources built on one particular provider type?”
Tell an agent
List all OAuth sources.
Show OAuth sources of provider type {provider_type}.
POST /sources/oauth/ Add an OAuth or OIDC login source · Sources oauth create #
Ask an LLM
“How do I add a new social or OpenID Connect login button to authentik?”
“What client credentials does a new OAuth source require?”
Tell an agent
Create OAuth source {name} with slug {slug}, type {provider_type}, key {consumer_key} and secret {consumer_secret}.
Add an OIDC source {name} (slug {slug}, type {provider_type}, key {consumer_key}, secret {consumer_secret}) from well-known URL {oidc_well_known_url}.
GET /sources/oauth/{slug}/ Get an OAuth source · Sources oauth retrieve #
Ask an LLM
“What authorization and token URLs does a specific OAuth source use?”
“Is PKCE enabled on one of my OAuth login sources?”
Tell an agent
Show OAuth source {slug}.
Get the endpoints and scopes of OAuth source {slug}.
PUT /sources/oauth/{slug}/ Replace an OAuth source's configuration · Sources oauth update #
Ask an LLM
“Can I overwrite an OAuth source's full configuration including its credentials?”
“What must I include when fully replacing an OAuth source?”
Tell an agent
Replace OAuth source {slug} with name {name}, slug {new_slug}, type {provider_type}, key {consumer_key} and secret {consumer_secret}.
Fully reconfigure OAuth source {slug} as provider type {provider_type}.
PATCH /sources/oauth/{slug}/ Change settings on an OAuth source · Sources oauth partial update #
Ask an LLM
“Can I rotate just the client secret on an OAuth source?”
“Is it possible to add extra scopes to an existing OAuth source without resending everything?”
Tell an agent
Set the client secret of OAuth source {slug} to {consumer_secret}.
Add scopes {additional_scopes} to OAuth source {slug}.
DELETE /sources/oauth/{slug}/ Delete an OAuth source · Sources oauth destroy #
Ask an LLM
“How do I remove a social login option from authentik?”
“What happens to users' linked accounts when an OAuth source is deleted?”
Tell an agent destructive · confirm first
Delete OAuth source {slug}.
Remove the social login source {slug}.
GET /sources/oauth/{slug}/used_by/ See what uses an OAuth source · Sources oauth used by list #
Ask an LLM
“Which objects reference an OAuth login source?”
“Is an OAuth source still used somewhere before I delete it?”
Tell an agent
List objects that use OAuth source {slug}.
Check dependents of OAuth source {slug}.
GET /sources/oauth/source_types/ List supported OAuth provider types · Sources oauth source types list #
Ask an LLM
“Which built-in provider types can an OAuth source be based on?”
“What default URLs does authentik use for a given OAuth provider type?”
Tell an agent
List all OAuth source provider types.
Show the OAuth provider type named {name}.
GET /sources/plex/ List Plex sources · Sources plex list #
Ask an LLM
“Which Plex login sources are configured?”
“Can I find Plex sources that allow friends of the server owner to sign in?”
Tell an agent
List all Plex sources.
Show Plex sources where allow friends is {allow_friends}.
POST /sources/plex/ Add a Plex login source · Sources plex create #
Ask an LLM
“How do I let people sign in to authentik with their Plex account?”
“What token does a new Plex source require?”
Tell an agent
Create Plex source {name} with slug {slug} using Plex token {plex_token}.
Add Plex source {name} (slug {slug}, token {plex_token}) limited to servers {allowed_servers}.
GET /sources/plex/{slug}/ Get a Plex source · Sources plex retrieve #
Ask an LLM
“Which Plex servers are allowed on a specific Plex source?”
“Does one of my Plex sources let friends log in?”
Tell an agent
Show Plex source {slug}.
Get the allowed servers on Plex source {slug}.
PUT /sources/plex/{slug}/ Replace a Plex source's configuration · Sources plex update #
Ask an LLM
“Can I overwrite a Plex source's full configuration?”
“What fields are required when replacing a Plex source?”
Tell an agent
Replace Plex source {slug} with name {name}, slug {new_slug} and token {plex_token}.
Fully reconfigure Plex source {slug} with Plex token {plex_token}.
PATCH /sources/plex/{slug}/ Change settings on a Plex source · Sources plex partial update #
Ask an LLM
“Can I change only the allowed servers on a Plex source?”
“Is there a way to stop friends from logging in via Plex without redoing the source?”
Tell an agent
Set allowed servers on Plex source {slug} to {allowed_servers}.
Set allow friends to {allow_friends} on Plex source {slug}.
DELETE /sources/plex/{slug}/ Delete a Plex source · Sources plex destroy #
Ask an LLM
“How do I remove Plex login from authentik?”
“Is deleting a Plex source permanent?”
Tell an agent destructive · confirm first
Delete Plex source {slug}.
Remove the Plex login source {slug}.
GET /sources/plex/{slug}/used_by/ See what uses a Plex source · Sources plex used by list #
Ask an LLM
“Which objects reference a Plex source?”
“Does anything depend on my Plex source?”
Tell an agent
List objects that use Plex source {slug}.
Check dependents of Plex source {slug}.
POST /sources/plex/redeem_token/ Redeem a Plex token to start sign-in · Sources plex redeem token create #
Ask an LLM
“How does authentik check a Plex token against the servers a source allows?”
“What happens after a Plex token is redeemed for a user who isn't logged in yet?”
Tell an agent
Redeem Plex token {plex_token} against source {slug} and start the login flow.
Validate Plex token {plex_token} for server access and redirect to enrollment.
POST /sources/plex/redeem_token_authenticated/ Link a Plex account to a signed-in user · Sources plex redeem token authenticated create #
Ask an LLM
“Can an already logged-in user connect their Plex account by redeeming a token?”
“What creates a Plex user connection for someone who is already authenticated?”
Tell an agent
Redeem Plex token {plex_token} for my signed-in account on source {slug}.
Connect my current user to Plex using token {plex_token}.
GET /sources/saml/ List SAML sources · Sources saml list #
Ask an LLM
“Which SAML identity providers are configured as login sources?”
“Can I find SAML sources that allow IdP-initiated logins?”
Tell an agent
List all SAML sources.
Show SAML sources with SSO URL {sso_url}.
POST /sources/saml/ Add a SAML login source · Sources saml create #
Ask an LLM
“How do I federate authentik with an external SAML identity provider?”
“Which settings are mandatory for a new SAML source?”
Tell an agent
Create SAML source {name} with slug {slug}, SSO URL {sso_url} and pre-auth flow {pre_authentication_flow}.
Add SAML source {name} (slug {slug}, SSO {sso_url}, pre-auth flow {pre_authentication_flow}) with logout URL {slo_url}.
GET /sources/saml/{slug}/ Get a SAML source · Sources saml retrieve #
Ask an LLM
“What SSO URL and signing settings does a particular SAML source use?”
“Is force re-authentication on for one of my SAML sources?”
Tell an agent
Show SAML source {slug}.
Get the signing and binding settings of SAML source {slug}.
PUT /sources/saml/{slug}/ Replace a SAML source's configuration · Sources saml update #
Ask an LLM
“Can I overwrite a SAML source's whole configuration in one call?”
“What is required when fully replacing a SAML source?”
Tell an agent
Replace SAML source {slug} with name {name}, slug {new_slug}, SSO URL {sso_url} and pre-auth flow {pre_authentication_flow}.
Fully reconfigure SAML source {slug} to use SSO URL {sso_url}.
PATCH /sources/saml/{slug}/ Change settings on a SAML source · Sources saml partial update #
Ask an LLM
“Can I swap only the verification certificate on a SAML source?”
“Is it possible to switch a SAML source's binding type without resending everything?”
Tell an agent
Set the verification keypair on SAML source {slug} to {verification_kp}.
Change the binding type of SAML source {slug} to {binding_type}.
DELETE /sources/saml/{slug}/ Delete a SAML source · Sources saml destroy #
Ask an LLM
“How do I remove a SAML identity provider from authentik?”
“What happens to users linked through a SAML source if I delete it?”
Tell an agent destructive · confirm first
Delete SAML source {slug}.
Remove SAML identity provider source {slug}.
GET /sources/saml/{slug}/metadata/ Download a SAML source's metadata XML · Sources saml metadata retrieve #
Ask an LLM
“Where do I get the SP metadata XML to give my SAML identity provider?”
“Can I export a SAML source's metadata as XML?”
Tell an agent
Get the SAML metadata XML for source {slug}.
Export SP metadata for SAML source {slug} so I can upload it to the IdP.
GET /sources/saml/{slug}/used_by/ See what uses a SAML source · Sources saml used by list #
Ask an LLM
“Which objects reference a SAML source?”
“Is a SAML source still in use anywhere?”
Tell an agent
List objects that use SAML source {slug}.
Check dependents of SAML source {slug}.
GET /sources/scim/ List SCIM sources · Sources scim list #
Ask an LLM
“Which SCIM sources are provisioning users into authentik?”
“Can I search SCIM sources by name?”
Tell an agent
List all SCIM sources.
Find SCIM sources named {name}.
POST /sources/scim/ Add a SCIM provisioning source · Sources scim create #
Ask an LLM
“How do I let an external system push users and groups into authentik over SCIM?”
“What does a new SCIM source need?”
Tell an agent
Create SCIM source {name} with slug {slug}.
Add SCIM source {name} (slug {slug}) placing users under path template {user_path_template}.
GET /sources/scim/{slug}/ Get a SCIM source · Sources scim retrieve #
Ask an LLM
“What property mappings and user path does a SCIM source use?”
“Is a particular SCIM source enabled?”
Tell an agent
Show SCIM source {slug}.
Get the configuration of SCIM source {slug}.
PUT /sources/scim/{slug}/ Replace a SCIM source's configuration · Sources scim update #
Ask an LLM
“Can I overwrite a SCIM source's configuration fully?”
“Which fields are required when replacing a SCIM source?”
Tell an agent
Replace SCIM source {slug} with name {name} and slug {new_slug}.
Fully reconfigure SCIM source {slug} with user path template {user_path_template}.
PATCH /sources/scim/{slug}/ Change settings on a SCIM source · Sources scim partial update #
Ask an LLM
“Can I disable a SCIM source without deleting it?”
“Is it possible to change only the user path template on a SCIM source?”
Tell an agent
Set enabled to {enabled} on SCIM source {slug}.
Change the user path template of SCIM source {slug} to {user_path_template}.
DELETE /sources/scim/{slug}/ Delete a SCIM source · Sources scim destroy #
Ask an LLM
“How do I stop an external system provisioning via SCIM into authentik?”
“Is removing a SCIM source reversible?”
Tell an agent destructive · confirm first
Delete SCIM source {slug}.
Remove SCIM provisioning source {slug}.
GET /sources/scim/{slug}/used_by/ See what uses a SCIM source · Sources scim used by list #
Ask an LLM
“Which objects reference a SCIM source?”
“Does anything depend on a SCIM source I plan to remove?”
Tell an agent
List objects that use SCIM source {slug}.
Check dependents of SCIM source {slug}.
GET /sources/scim_groups/ List groups provisioned via SCIM · Sources scim groups list #
Ask an LLM
“Which groups were pushed into authentik by a SCIM source?”
“Can I find a SCIM-provisioned group by its authentik group name?”
Tell an agent
List SCIM source groups.
Show SCIM-provisioned groups from source {source_slug}.
POST /sources/scim_groups/ Record a SCIM-provisioned group · Sources scim groups create #
Ask an LLM
“How do I manually tie an authentik group to its external SCIM ID?”
“What's needed to create a SCIM source group record?”
Tell an agent
Create a SCIM group record linking group {group} to external ID {external_id} on source {source}.
Register SCIM external group {external_id} for group {group} from source {source} with attributes {attributes}.
GET /sources/scim_groups/{id}/ Get a SCIM-provisioned group record · Sources scim groups retrieve #
Ask an LLM
“What external ID and attributes are stored for a SCIM-provisioned group?”
“Which SCIM source created a given group record?”
Tell an agent
Show SCIM source group {id}.
Get the SCIM attributes stored on group record {id}.
PUT /sources/scim_groups/{id}/ Replace a SCIM group record · Sources scim groups update #
Ask an LLM
“Can I overwrite a SCIM group record's external ID, group and source together?”
“What's required to fully replace a SCIM source group?”
Tell an agent
Replace SCIM group record {id} with external ID {external_id}, group {group} and source {source}.
Overwrite SCIM source group {id} in full.
PATCH /sources/scim_groups/{id}/ Edit part of a SCIM group record · Sources scim groups partial update #
Ask an LLM
“Can I change only the external ID on a SCIM-provisioned group?”
“Is it possible to update the stored SCIM attributes of a group without resending the rest?”
Tell an agent
Set external ID {external_id} on SCIM group record {id}.
Update the SCIM attributes of group record {id} to {attributes}.
DELETE /sources/scim_groups/{id}/ Delete a SCIM group record · Sources scim groups destroy #
Ask an LLM
“Can I remove the SCIM link for a provisioned group?”
“What happens when a SCIM source group record is deleted?”
Tell an agent destructive · confirm first
Delete SCIM source group {id}.
Remove the SCIM group record {id}.
GET /sources/scim_groups/{id}/used_by/ See what uses a SCIM group record · Sources scim groups used by list #
Ask an LLM
“What references a SCIM-provisioned group record?”
“Is a SCIM source group depended on by anything?”
Tell an agent
List objects that use SCIM group record {id}.
Check dependents of SCIM source group {id}.
GET /sources/scim_users/ List users provisioned via SCIM · Sources scim users list #
Ask an LLM
“Which users were pushed into authentik by a SCIM source?”
“Can I find the SCIM record for a user by username?”
Tell an agent
List SCIM source users.
Show SCIM-provisioned users from source {source_slug}.
POST /sources/scim_users/ Record a SCIM-provisioned user · Sources scim users create #
Ask an LLM
“How do I manually map an authentik user to their external SCIM ID?”
“What does creating a SCIM source user record require?”
Tell an agent
Create a SCIM user record linking user {user} to external ID {external_id} on source {source}.
Register SCIM external user {external_id} for user {user} from source {source} with attributes {attributes}.
GET /sources/scim_users/{id}/ Get a SCIM-provisioned user record · Sources scim users retrieve #
Ask an LLM
“What external ID and SCIM attributes are stored for a provisioned user?”
“Which SCIM source created a particular user record?”
Tell an agent
Show SCIM source user {id}.
Get the SCIM attributes on user record {id}.
PUT /sources/scim_users/{id}/ Replace a SCIM user record · Sources scim users update #
Ask an LLM
“Can I overwrite a SCIM user record's external ID, user and source at once?”
“What's required to fully replace a SCIM source user?”
Tell an agent
Replace SCIM user record {id} with external ID {external_id}, user {user} and source {source}.
Overwrite SCIM source user {id} completely.
PATCH /sources/scim_users/{id}/ Edit part of a SCIM user record · Sources scim users partial update #
Ask an LLM
“Can I change only the external ID of a SCIM-provisioned user?”
“Is it possible to patch the stored SCIM attributes of a user?”
Tell an agent
Set external ID {external_id} on SCIM user record {id}.
Update the SCIM attributes of user record {id} to {attributes}.
DELETE /sources/scim_users/{id}/ Delete a SCIM user record · Sources scim users destroy #
Ask an LLM
“Can I remove the SCIM link for a provisioned user?”
“Does deleting a SCIM source user record affect the authentik user?”
Tell an agent destructive · confirm first
Delete SCIM source user {id}.
Remove the SCIM user record {id}.
GET /sources/scim_users/{id}/used_by/ See what uses a SCIM user record · Sources scim users used by list #
Ask an LLM
“What references a SCIM-provisioned user record?”
“Is a SCIM source user depended on by other objects?”
Tell an agent
List objects that use SCIM user record {id}.
Check dependents of SCIM source user {id}.
GET /sources/telegram/ List Telegram sources · Sources telegram list #
Ask an LLM
“Which Telegram bot login sources are set up in authentik?”
“Can I find a Telegram source by its bot username?”
Tell an agent
List all Telegram sources.
Show Telegram sources for bot {bot_username}.
POST /sources/telegram/ Add a Telegram login source · Sources telegram create #
Ask an LLM
“How do I let users sign in to authentik with Telegram?”
“What bot details does a new Telegram source need?”
Tell an agent
Create Telegram source {name} with slug {slug} for bot {bot_username} using token {bot_token} and pre-auth flow {pre_authentication_flow}.
Add Telegram login {name} (slug {slug}) with bot {bot_username}, token {bot_token}, pre-auth flow {pre_authentication_flow}.
GET /sources/telegram/{slug}/ Get a Telegram source · Sources telegram retrieve #
Ask an LLM
“Which bot does a particular Telegram source use?”
“Does one of my Telegram sources request permission to message users?”
Tell an agent
Show Telegram source {slug}.
Get the bot settings of Telegram source {slug}.
PUT /sources/telegram/{slug}/ Replace a Telegram source's configuration · Sources telegram update #
Ask an LLM
“Can I overwrite a Telegram source's full configuration?”
“Which fields must I send to fully replace a Telegram source?”
Tell an agent
Replace Telegram source {slug} with name {name}, slug {new_slug}, bot {bot_username}, token {bot_token}, pre-auth flow {pre_authentication_flow}.
Fully reconfigure Telegram source {slug} to use bot {bot_username}.
PATCH /sources/telegram/{slug}/ Change settings on a Telegram source · Sources telegram partial update #
Ask an LLM
“Can I rotate just the bot token on a Telegram source?”
“Is it possible to turn off message access on a Telegram source without redoing it?”
Tell an agent
Set the bot token of Telegram source {slug} to {bot_token}.
Set request message access to {request_message_access} on Telegram source {slug}.
DELETE /sources/telegram/{slug}/ Delete a Telegram source · Sources telegram destroy #
Ask an LLM
“How do I remove Telegram login from authentik?”
“Is deleting a Telegram source permanent?”
Tell an agent destructive · confirm first
Delete Telegram source {slug}.
Remove the Telegram login source {slug}.
POST /sources/telegram/{slug}/connect_user/ Connect a Telegram account to a user · Sources telegram connect user create #
Ask an LLM
“How do I link someone's Telegram account to their authentik user using the login widget data?”
“What Telegram auth fields are needed to connect a user to a Telegram source?”
Tell an agent
Connect Telegram user {telegram_id} to source {slug} with auth date {auth_date} and hash {hash}.
Link Telegram account {telegram_id} (username {username}) via source {slug}, auth date {auth_date}, hash {hash}.
GET /sources/telegram/{slug}/used_by/ See what uses a Telegram source · Sources telegram used by list #
Ask an LLM
“Which objects reference a Telegram source?”
“Does anything depend on my Telegram login source?”
Tell an agent
List objects that use Telegram source {slug}.
Check dependents of Telegram source {slug}.
GET /sources/user_connections/all/ List user-source connections of every type · Sources user connections all list #
Ask an LLM
“Which external accounts are linked to authentik users, across all source types?”
“Can I see every source a specific user has connected?”
Tell an agent
List all user-source connections.
Show user connections of every source type for user {user}.
GET /sources/user_connections/all/{id}/ Get a user-source connection of any type · Sources user connections all retrieve #
Ask an LLM
“What external identifier is linked to a user in one connection, whatever the source type?”
“Can I read a user's source link without knowing if it's OAuth, SAML or LDAP?”
Tell an agent
Show user-source connection {id} from the all-types endpoint.
Get the identifier on generic user connection {id}.
PUT /sources/user_connections/all/{id}/ Replace a user-source connection of any type · Sources user connections all update #
Ask an LLM
“Can I overwrite a user's source link through the endpoint covering all source types?”
“What must be sent to replace a generic user connection?”
Tell an agent
Replace generic user connection {id} with source {source} and identifier {identifier}.
Overwrite user connection {id} via the all-types endpoint with identifier {identifier}.
PATCH /sources/user_connections/all/{id}/ Edit part of a user-source connection of any type · Sources user connections all partial update #
Ask an LLM
“Can I patch just the identifier on a user link through the generic endpoint?”
“Is there a partial update that works for user connections of any source type?”
Tell an agent
Change just the identifier on generic user connection {id} to {identifier}.
Patch user connection {id} (any type) to point at source {source}.
DELETE /sources/user_connections/all/{id}/ Delete a user-source connection of any type · Sources user connections all destroy #
Ask an LLM
“How can I unlink a user's external account without knowing the source type?”
“Does removing a generic user connection delete the user?”
Tell an agent destructive · confirm first
Delete user-source connection {id} via the all-types endpoint.
Unlink generic user connection {id}.
GET /sources/user_connections/all/{id}/used_by/ See what uses a user-source connection of any type · Sources user connections all used by list #
Ask an LLM
“Which objects reference a user connection, whatever its source type?”
“Is a user's external account link referenced by anything, regardless of source type?”
Tell an agent
List dependents of generic user connection {id}.
Show what uses user-source connection {id} across source types.
GET /sources/user_connections/kerberos/ List Kerberos user connections · Sources user connections kerberos list #
Ask an LLM
“Which users have a Kerberos principal linked to their account?”
“Can I list Kerberos user links for just one user?”
Tell an agent
List Kerberos user connections.
Show Kerberos user links for user {user}.
POST /sources/user_connections/kerberos/ Link a user to a Kerberos principal · Sources user connections kerberos create #
Ask an LLM
“How do I link a user to their Kerberos principal?”
“What identifier does a new Kerberos user connection take?”
Tell an agent
Link a user to Kerberos source {source} with principal {identifier}.
Create a Kerberos user connection for principal {identifier}.
GET /sources/user_connections/kerberos/{id}/ Get a Kerberos user connection · Sources user connections kerberos retrieve #
Ask an LLM
“Which Kerberos principal is stored on a single user link?”
“What Kerberos source does one user connection belong to?”
Tell an agent
Show Kerberos user connection {id}.
Get the principal on Kerberos user link {id}.
PUT /sources/user_connections/kerberos/{id}/ Replace a Kerberos user connection · Sources user connections kerberos update #
Ask an LLM
“Can I fully replace a Kerberos user connection?”
“What's required to overwrite a Kerberos user link?”
Tell an agent
Replace Kerberos user connection {id} with source {source} and principal {identifier}.
Overwrite Kerberos user link {id} entirely.
PATCH /sources/user_connections/kerberos/{id}/ Edit part of a Kerberos user connection · Sources user connections kerberos partial update #
Ask an LLM
“Is there a way to change only the principal on a Kerberos user link?”
“Can I point a Kerberos user connection at another Kerberos source?”
Tell an agent
Set principal {identifier} on Kerberos user connection {id}.
Move Kerberos user link {id} to source {source}.
DELETE /sources/user_connections/kerberos/{id}/ Delete a Kerberos user connection · Sources user connections kerberos destroy #
Ask an LLM
“Can I unlink a user from their Kerberos principal?”
“What happens when a Kerberos user connection is removed?”
Tell an agent destructive · confirm first
Delete Kerberos user connection {id}.
Unlink the Kerberos principal on user link {id}.
GET /sources/user_connections/kerberos/{id}/used_by/ See what uses a Kerberos user connection · Sources user connections kerberos used by list #
Ask an LLM
“What references a Kerberos user connection?”
“Is anything depending on a Kerberos user link?”
Tell an agent
List objects that use Kerberos user connection {id}.
Check dependents of Kerberos user link {id}.
GET /sources/user_connections/ldap/ List LDAP user connections · Sources user connections ldap list #
Ask an LLM
“Which authentik users are tied to entries in an LDAP directory?”
“Can I search LDAP user connections?”
Tell an agent
List LDAP user connections.
Search LDAP user links for {search}.
POST /sources/user_connections/ldap/ Link a user to an LDAP entry · Sources user connections ldap create #
Ask an LLM
“How do I tie an authentik user to an LDAP directory entry by hand?”
“What identifier does an LDAP user connection need?”
Tell an agent
Link a user to LDAP source {source} with identifier {identifier}.
Create an LDAP user connection for directory ID {identifier}.
GET /sources/user_connections/ldap/{id}/ Get a LDAP user connection · Sources user connections ldap retrieve #
Ask an LLM
“Which LDAP entry is a given user connection mapped to?”
“Can I read the LDAP identifier on one user link?”
Tell an agent
Show LDAP user connection {id}.
Get the LDAP source behind user link {id}.
PUT /sources/user_connections/ldap/{id}/ Replace a LDAP user connection · Sources user connections ldap update #
Ask an LLM
“Can I overwrite an LDAP user connection completely?”
“What does a full replace of an LDAP user link require?”
Tell an agent
Replace LDAP user connection {id} with source {source} and identifier {identifier}.
Overwrite LDAP user link {id} with identifier {identifier}.
PATCH /sources/user_connections/ldap/{id}/ Edit part of a LDAP user connection · Sources user connections ldap partial update #
Ask an LLM
“Can I update only the identifier on an LDAP user link?”
“Is there a partial update for LDAP user connections?”
Tell an agent
Change the identifier of LDAP user connection {id} to {identifier}.
Reassign LDAP user link {id} to source {source}.
DELETE /sources/user_connections/ldap/{id}/ Delete a LDAP user connection · Sources user connections ldap destroy #
Ask an LLM
“Can I disconnect a user from their LDAP directory entry?”
“Will deleting an LDAP user connection stop that user syncing?”
Tell an agent destructive · confirm first
Delete LDAP user connection {id}.
Unlink the user behind LDAP connection {id}.
GET /sources/user_connections/ldap/{id}/used_by/ See what uses a LDAP user connection · Sources user connections ldap used by list #
Ask an LLM
“What objects depend on an LDAP user connection?”
“Is an LDAP user link referenced elsewhere?”
Tell an agent
List dependents of LDAP user connection {id}.
Show what uses LDAP user link {id}.
GET /sources/user_connections/oauth/ List OAuth user connections · Sources user connections oauth list #
Ask an LLM
“Which users have signed in with a social or OIDC account?”
“Can I see OAuth-linked accounts for a single user?”
Tell an agent
List OAuth user connections.
Show OAuth user links for user {user}.
POST /sources/user_connections/oauth/ Link a user to an OAuth account · Sources user connections oauth create #
Ask an LLM
“How do I link an authentik user to their account at an OAuth provider?”
“Can I store an access token and expiry when creating an OAuth user connection?”
Tell an agent
Link a user to OAuth source {source} with remote ID {identifier}.
Create an OAuth user connection for remote ID {identifier} with access token {access_token} expiring {expires}.
GET /sources/user_connections/oauth/{id}/ Get a OAuth user connection · Sources user connections oauth retrieve #
Ask an LLM
“What remote account ID and token expiry are stored on an OAuth user link?”
“Which OAuth source does one user connection belong to?”
Tell an agent
Show OAuth user connection {id}.
Get the token expiry on OAuth user link {id}.
PUT /sources/user_connections/oauth/{id}/ Replace a OAuth user connection · Sources user connections oauth update #
Ask an LLM
“Can I overwrite an OAuth user connection including its access token?”
“What must I send to fully replace an OAuth user link?”
Tell an agent
Replace OAuth user connection {id} with source {source} and remote ID {identifier}.
Overwrite OAuth user link {id} with access token {access_token}.
PATCH /sources/user_connections/oauth/{id}/ Edit part of a OAuth user connection · Sources user connections oauth partial update #
Ask an LLM
“Can I refresh only the stored access token on an OAuth user link?”
“Is it possible to change just the expiry of an OAuth user connection?”
Tell an agent
Set access token {access_token} on OAuth user connection {id}.
Change the expiry of OAuth user link {id} to {expires}.
DELETE /sources/user_connections/oauth/{id}/ Delete a OAuth user connection · Sources user connections oauth destroy #
Ask an LLM
“Can I disconnect a user's social login account?”
“What happens when an OAuth user connection is deleted?”
Tell an agent destructive · confirm first
Delete OAuth user connection {id}.
Unlink the social account on OAuth user link {id}.
GET /sources/user_connections/oauth/{id}/used_by/ See what uses a OAuth user connection · Sources user connections oauth used by list #
Ask an LLM
“What references an OAuth user connection?”
“Does anything rely on an OAuth user link?”
Tell an agent
List objects using OAuth user connection {id}.
Check what depends on OAuth user link {id}.
GET /sources/user_connections/plex/ List Plex user connections · Sources user connections plex list #
Ask an LLM
“Which users have a Plex account connected?”
“Can I list Plex user links for one Plex source?”
Tell an agent
List Plex user connections.
Show Plex user links from source {source_slug}.
POST /sources/user_connections/plex/ Link a user to a Plex account · Sources user connections plex create #
Ask an LLM
“How do I link a user to their Plex account with a Plex token?”
“What does a new Plex user connection require?”
Tell an agent
Link a user to Plex source {source} with identifier {identifier} and token {plex_token}.
Create a Plex user connection for Plex ID {identifier} using token {plex_token}.
GET /sources/user_connections/plex/{id}/ Get a Plex user connection · Sources user connections plex retrieve #
Ask an LLM
“What's stored on a single Plex user link?”
“Which Plex source is one user connection tied to?”
Tell an agent
Show Plex user connection {id}.
Get the identifier of Plex user link {id}.
PUT /sources/user_connections/plex/{id}/ Replace a Plex user connection · Sources user connections plex update #
Ask an LLM
“Can I fully replace a Plex user connection including its token?”
“What's required to overwrite a Plex user link?”
Tell an agent
Replace Plex user connection {id} with source {source}, identifier {identifier} and token {plex_token}.
Overwrite Plex user link {id} completely.
PATCH /sources/user_connections/plex/{id}/ Edit part of a Plex user connection · Sources user connections plex partial update #
Ask an LLM
“Can I update only the Plex token on a user connection?”
“Is there a partial update for Plex user links?”
Tell an agent
Set Plex token {plex_token} on Plex user connection {id}.
Change the identifier of Plex user link {id} to {identifier}.
DELETE /sources/user_connections/plex/{id}/ Delete a Plex user connection · Sources user connections plex destroy #
Ask an LLM
“Can I unlink a user's Plex account?”
“Is deleting a Plex user connection reversible?”
Tell an agent destructive · confirm first
Delete Plex user connection {id}.
Remove the Plex account link {id}.
GET /sources/user_connections/plex/{id}/used_by/ See what uses a Plex user connection · Sources user connections plex used by list #
Ask an LLM
“What depends on a Plex user connection?”
“Is a Plex user link referenced by other objects?”
Tell an agent
List dependents of Plex user connection {id}.
Show what uses Plex user link {id}.
GET /sources/user_connections/saml/ List SAML user connections · Sources user connections saml list #
Ask an LLM
“Which users are linked to a SAML identity provider?”
“Can I list SAML user connections for a single user?”
Tell an agent
List SAML user connections.
Show SAML user links for user {user}.
POST /sources/user_connections/saml/ Link a user to a SAML identity · Sources user connections saml create #
Ask an LLM
“How do I link a user to their SAML NameID from an identity provider?”
“What identifier does a new SAML user connection expect?”
Tell an agent
Link a user to SAML source {source} with NameID {identifier}.
Create a SAML user connection for NameID {identifier}.
GET /sources/user_connections/saml/{id}/ Get a SAML user connection · Sources user connections saml retrieve #
Ask an LLM
“What SAML NameID is stored on a specific user link?”
“Which SAML source owns one user connection?”
Tell an agent
Show SAML user connection {id}.
Get the NameID on SAML user link {id}.
PUT /sources/user_connections/saml/{id}/ Replace a SAML user connection · Sources user connections saml update #
Ask an LLM
“Can I replace a SAML user connection's source and identifier together?”
“What's needed to fully overwrite a SAML user link?”
Tell an agent
Replace SAML user connection {id} with source {source} and NameID {identifier}.
Overwrite SAML user link {id} in full.
PATCH /sources/user_connections/saml/{id}/ Edit part of a SAML user connection · Sources user connections saml partial update #
Ask an LLM
“Can I change only the NameID on a SAML user link?”
“Is there a partial update for SAML user connections?”
Tell an agent
Change the NameID on SAML user connection {id} to {identifier}.
Point SAML user link {id} to source {source}.
DELETE /sources/user_connections/saml/{id}/ Delete a SAML user connection · Sources user connections saml destroy #
Ask an LLM
“Can I disconnect a user from their SAML identity?”
“What happens when a SAML user connection is deleted?”
Tell an agent destructive · confirm first
Delete SAML user connection {id}.
Unlink SAML user mapping {id}.
GET /sources/user_connections/saml/{id}/used_by/ See what uses a SAML user connection · Sources user connections saml used by list #
Ask an LLM
“What references a SAML user connection?”
“Is anything relying on a SAML user link I want to remove?”
Tell an agent
List objects using SAML user connection {id}.
Check dependents of SAML user link {id}.
GET /sources/user_connections/telegram/ List Telegram user connections · Sources user connections telegram list #
Ask an LLM
“Which users have a Telegram account connected?”
“Can I search Telegram user connections?”
Tell an agent
List Telegram user connections.
Search Telegram user links for {search}.
POST /sources/user_connections/telegram/ Link a user to a Telegram account · Sources user connections telegram create #
Ask an LLM
“How do I record a Telegram user connection by hand, without the login widget?”
“What identifier does a Telegram user connection need?”
Tell an agent
Link a user to Telegram source {source} with Telegram ID {identifier}.
Create a Telegram user connection record for Telegram ID {identifier}.
GET /sources/user_connections/telegram/{id}/ Get a Telegram user connection · Sources user connections telegram retrieve #
Ask an LLM
“What does one Telegram user link contain?”
“Which Telegram source is a user connection tied to?”
Tell an agent
Show Telegram user connection {id}.
Get the Telegram ID on user link {id}.
PUT /sources/user_connections/telegram/{id}/ Replace a Telegram user connection · Sources user connections telegram update #
Ask an LLM
“Can I overwrite a Telegram user connection entirely?”
“What must I send to replace a Telegram user link?”
Tell an agent
Replace Telegram user connection {id} with source {source} and Telegram ID {identifier}.
Fully overwrite Telegram user link {id}.
PATCH /sources/user_connections/telegram/{id}/ Edit part of a Telegram user connection · Sources user connections telegram partial update #
Ask an LLM
“Can I update only the Telegram ID on a user link?”
“Is it possible to move a Telegram user connection to another Telegram source?”
Tell an agent
Set Telegram ID {identifier} on Telegram user connection {id}.
Move Telegram user link {id} to source {source}.
DELETE /sources/user_connections/telegram/{id}/ Delete a Telegram user connection · Sources user connections telegram destroy #
Ask an LLM
“Can I unlink a user's Telegram account?”
“Does deleting a Telegram user connection remove the authentik user?”
Tell an agent destructive · confirm first
Delete Telegram user connection {id}.
Remove the Telegram account link {id}.
GET /sources/user_connections/telegram/{id}/used_by/ See what uses a Telegram user connection · Sources user connections telegram used by list #
Ask an LLM
“What depends on a Telegram user connection?”
“Is a Telegram user link referenced anywhere?”
Tell an agent
List dependents of Telegram user connection {id}.
Show what uses Telegram user link {id}.

Documentation

📖
Documentation
https://docs.goauthentik.io/developer-docs/api/
📖
APIReference
https://api.goauthentik.io/
📖
Documentation
https://docs.goauthentik.io

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-sources-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/goauthentik/authentik

Other Resources

🔗
SDKs
https://pypi.org/project/authentik-client/
🔗
SDKs
https://www.npmjs.com/package/@goauthentik/api
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/overlays/authentik-sources-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/authentik:authentik-sources-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

authentik-sources-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: authentik Sources API
  version: 2026.11.0-rc1
  description: Making authentication simple.
  contact:
    email: hello@goauthentik.io
  license:
    name: MIT
    url: https://github.com/goauthentik/authentik/blob/main/LICENSE
  x-source-url: https://api.goauthentik.io/schema.yml
  x-last-validated: '2026-09-04'
servers:
- url: /api/v3
tags:


# --- truncated at 32 KB (286 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-sources-api-openapi.yml