Authentik

Authentik Providers API

Protocol providers: OAuth2/OIDC, SAML, SCIM, LDAP, RADIUS, Proxy, RAC, WS-Fed, Google Workspace, Microsoft Entra and the Shared Signals Framework backchannel.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 131

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 /providers/all/ List all providers of every type · Providers all list #
Ask an LLM
“Which providers of any type are configured in my authentik instance?”
“Can I see only backchannel providers, or exclude them from the full provider list?”
Tell an agent
List every provider across all protocol types.
Search all providers for {search}.
GET /providers/all/{id}/ Get any provider by ID · Providers all retrieve #
Ask an LLM
“What type of provider is a given provider ID, whatever its protocol?”
“Can I look up a provider generically without knowing if it is OAuth2, SAML or LDAP?”
Tell an agent
Get provider {id} from the generic all-providers endpoint.
Show the basic details of provider {id} regardless of its type.
DELETE /providers/all/{id}/ Delete a provider of any type · Providers all destroy #
Ask an LLM
“Can I delete a provider without knowing which protocol type it is?”
“What happens when I remove a provider through the generic provider endpoint?”
Tell an agent destructive · confirm first
Delete provider {id} via the all-providers endpoint.
Remove provider {id}, whatever its type.
GET /providers/all/{id}/used_by/ See what depends on a provider · Providers all used by list #
Ask an LLM
“What objects reference a provider before I delete it, whatever its type?”
“Is any application still using this provider from the generic list?”
Tell an agent
List everything that uses provider {id} via the generic provider endpoint.
Show the dependents of provider {id} before I remove it.
GET /providers/all/types/ List creatable provider types · Providers all types list #
Ask an LLM
“What kinds of providers can I create in authentik?”
“Which provider protocols are available to add, like OAuth2, SAML or proxy?”
Tell an agent
List all the provider types I can create.
Show me the available provider type options.
GET /providers/google_workspace/ List Google Workspace providers · Providers google workspace list #
Ask an LLM
“Which Google Workspace sync providers have I set up?”
“Can I filter Google Workspace providers by the delegated admin subject?”
Tell an agent
List my Google Workspace providers.
Find Google Workspace providers delegated to {delegated_subject}.
POST /providers/google_workspace/ Create a Google Workspace provider · Providers google workspace create #
Ask an LLM
“How do I sync authentik users and groups into Google Workspace?”
“What credentials and delegated subject does a new Google Workspace provider need?”
Tell an agent
Create Google Workspace provider {name} as {delegated_subject} with credentials {credentials}, group domain {default_group_email_domain}.
Set up Google sync {name}, dry run {dry_run}, impersonating {delegated_subject}, key {credentials}, domain {default_group_email_domain}.
GET /providers/google_workspace/{id}/ Get a Google Workspace provider · Providers google workspace retrieve #
Ask an LLM
“What settings does a specific Google Workspace provider use for user deletion?”
“Which OAuth scopes is my Google Workspace provider configured with?”
Tell an agent
Get Google Workspace provider {id}.
Show the configuration of Google Workspace provider {id}.
PUT /providers/google_workspace/{id}/ Replace a Google Workspace provider's config · Providers google workspace update #
Ask an LLM
“Can I fully replace the configuration of an existing Google Workspace provider?”
“How do I swap the service account credentials on a Google Workspace provider?”
Tell an agent
Replace Google Workspace provider {id} with name {name}, subject {delegated_subject}, credentials {credentials}, domain {default_group_email_domain}.
Overwrite Google Workspace provider {id}: {name}, key {credentials}, subject {delegated_subject}, domain {default_group_email_domain}.
PATCH /providers/google_workspace/{id}/ Update some Google Workspace provider settings · Providers google workspace partial update #
Ask an LLM
“Can I turn off dry-run on a Google Workspace provider without resending everything?”
“How do I change only the group filter on my Google Workspace provider?”
Tell an agent
Set dry run to {dry_run} on Google Workspace provider {id}.
Change the user delete action on Google Workspace provider {id} to {user_delete_action}.
DELETE /providers/google_workspace/{id}/ Delete a Google Workspace provider · Providers google workspace destroy #
Ask an LLM
“Can I remove a Google Workspace sync provider I no longer need?”
“Does deleting a Google Workspace provider stop syncing to Google?”
Tell an agent destructive · confirm first
Delete Google Workspace provider {id}.
Remove the Google Workspace sync provider {id}.
POST /providers/google_workspace/{id}/sync/object/ Re-sync one user or group to Google Workspace · Providers google workspace sync object create #
Ask an LLM
“Can I push a single user to Google Workspace without running a full sync?”
“Is it possible to force one group to re-sync to Google even while in dry run?”
Tell an agent
Sync {sync_object_model} {sync_object_id} to Google Workspace provider {id}.
Re-sync object {sync_object_id} of type {sync_object_model} through Google Workspace provider {id}, overriding dry run {override_dry_run}.
GET /providers/google_workspace/{id}/sync/status/ Check a Google Workspace provider's sync status · Providers google workspace sync status retrieve #
Ask an LLM
“Is my Google Workspace sync currently running or did it finish?”
“When did the last Google Workspace provider sync complete?”
Tell an agent
Check the sync status of Google Workspace provider {id}.
Show whether Google Workspace provider {id} is syncing right now.
GET /providers/google_workspace/{id}/used_by/ See what uses a Google Workspace provider · Providers google workspace used by list #
Ask an LLM
“What objects depend on my Google Workspace provider?”
“Is any application still bound to this Google Workspace sync provider?”
Tell an agent
List the objects that use Google Workspace provider {id}.
Show dependents of Google Workspace provider {id}.
GET /providers/google_workspace_groups/ List groups synced to Google Workspace · Providers google workspace groups list #
Ask an LLM
“Which authentik groups have been mapped to Google Workspace groups?”
“Can I find the Google group linked to a specific authentik group name?”
Tell an agent
List Google Workspace group mappings.
Show Google Workspace group links for authentik group {group_name}.
POST /providers/google_workspace_groups/ Link a group to a Google Workspace group · Providers google workspace groups create #
Ask an LLM
“How do I manually tie an authentik group to an existing Google group ID?”
“Can I record a Google Workspace group mapping by hand?”
Tell an agent
Link authentik group {group} to Google group {google_id} on provider {provider}.
Create a Google Workspace group mapping: Google ID {google_id}, group {group}, provider {provider}.
GET /providers/google_workspace_groups/{id}/ Get a Google Workspace group mapping · Providers google workspace groups retrieve #
Ask an LLM
“Which Google group ID does a particular group mapping point to?”
“What authentik group is behind this Google Workspace group link?”
Tell an agent
Get Google Workspace group mapping {id}.
Show the Google group link {id}.
DELETE /providers/google_workspace_groups/{id}/ Remove a Google Workspace group mapping · Providers google workspace groups destroy #
Ask an LLM
“Can I unlink an authentik group from its Google Workspace group?”
“What happens if I delete a Google group mapping record?”
Tell an agent destructive · confirm first
Delete Google Workspace group mapping {id}.
Unlink the Google group mapping {id}.
GET /providers/google_workspace_groups/{id}/used_by/ See what uses a Google Workspace group mapping · Providers google workspace groups used by list #
Ask an LLM
“Does anything reference this Google Workspace group mapping?”
“What depends on a synced Google group link before I remove it?”
Tell an agent
List objects using Google Workspace group mapping {id}.
Show dependents of the Google group link {id}.
GET /providers/google_workspace_users/ List users synced to Google Workspace · Providers google workspace users list #
Ask an LLM
“Which authentik users have been provisioned into Google Workspace?”
“Can I check whether a given username is linked to a Google account?”
Tell an agent
List Google Workspace user mappings.
Find the Google Workspace user link for username {username}.
POST /providers/google_workspace_users/ Link a user to a Google Workspace account · Providers google workspace users create #
Ask an LLM
“How do I manually map an authentik user to an existing Google user ID?”
“Can I add a Google Workspace user link without running sync?”
Tell an agent
Link user {user} to Google user {google_id} on provider {provider}.
Create a Google Workspace user mapping for Google ID {google_id}, user {user}, provider {provider}.
GET /providers/google_workspace_users/{id}/ Get a Google Workspace user mapping · Providers google workspace users retrieve #
Ask an LLM
“Which Google account is a specific user mapping tied to?”
“What does a single Google Workspace user link record contain?”
Tell an agent
Get Google Workspace user mapping {id}.
Show the Google user link {id}.
DELETE /providers/google_workspace_users/{id}/ Remove a Google Workspace user mapping · Providers google workspace users destroy #
Ask an LLM
“Can I unlink a user from their Google Workspace account record?”
“Is it possible to delete a stale Google user mapping?”
Tell an agent destructive · confirm first
Delete Google Workspace user mapping {id}.
Unlink the Google user mapping {id}.
GET /providers/google_workspace_users/{id}/used_by/ See what uses a Google Workspace user mapping · Providers google workspace users used by list #
Ask an LLM
“Does anything reference this Google Workspace user mapping?”
“What depends on a synced Google user link?”
Tell an agent
List objects using Google Workspace user mapping {id}.
Show dependents of the Google user link {id}.
GET /providers/ldap/ List LDAP providers · Providers ldap list #
Ask an LLM
“Which LDAP outpost providers do I have configured?”
“Can I find LDAP providers by their base DN or TLS server name?”
Tell an agent
List my LDAP providers.
Find LDAP providers with base DN {base_dn}.
POST /providers/ldap/ Create an LDAP provider · Providers ldap create #
Ask an LLM
“How do I expose authentik users over LDAP for a legacy app?”
“Can a new LDAP provider support MFA during bind?”
Tell an agent
Create an LDAP provider {name} with authorization flow {authorization_flow} and invalidation flow {invalidation_flow}.
Set up LDAP provider {name} with base DN {base_dn}, bind flow {authorization_flow}, invalidation flow {invalidation_flow}.
GET /providers/ldap/{id}/ Get an LDAP provider · Providers ldap retrieve #
Ask an LLM
“What base DN and bind mode does a specific LDAP provider use?”
“Which certificate is my LDAP provider serving for LDAPS?”
Tell an agent
Get LDAP provider {id}.
Show the settings of LDAP provider {id}.
PUT /providers/ldap/{id}/ Replace an LDAP provider's config · Providers ldap update #
Ask an LLM
“Can I overwrite every setting of an LDAP provider in one request?”
“How do I fully reconfigure an existing LDAP provider?”
Tell an agent
Replace LDAP provider {id} with name {name}, authorization flow {authorization_flow}, invalidation flow {invalidation_flow}.
Overwrite LDAP provider {id}: name {name}, base DN {base_dn}, flows {authorization_flow} and {invalidation_flow}.
PATCH /providers/ldap/{id}/ Update some LDAP provider settings · Providers ldap partial update #
Ask an LLM
“Can I change just the base DN of my LDAP provider?”
“How do I enable MFA support on an existing LDAP provider?”
Tell an agent
Set the base DN of LDAP provider {id} to {base_dn}.
Turn MFA support {mfa_support} on LDAP provider {id}.
DELETE /providers/ldap/{id}/ Delete an LDAP provider · Providers ldap destroy #
Ask an LLM
“Can I remove an LDAP provider I'm no longer using?”
“Will deleting an LDAP provider break binds from my legacy apps?”
Tell an agent destructive · confirm first
Delete LDAP provider {id}.
Remove the LDAP provider {id}.
GET /providers/ldap/{id}/used_by/ See what uses an LDAP provider · Providers ldap used by list #
Ask an LLM
“Which applications or outposts depend on my LDAP provider?”
“Is an LDAP provider still referenced anywhere?”
Tell an agent
List objects that use LDAP provider {id}.
Show dependents of LDAP provider {id}.
GET /providers/microsoft_entra/ List Microsoft Entra providers · Providers microsoft entra list #
Ask an LLM
“Which Microsoft Entra ID sync providers are configured?”
“Can I list Entra providers that exclude service account users?”
Tell an agent
List my Microsoft Entra providers.
Find Microsoft Entra providers named {name}.
POST /providers/microsoft_entra/ Create a Microsoft Entra provider · Providers microsoft entra create #
Ask an LLM
“How do I provision authentik users and groups into Microsoft Entra ID?”
“What app registration details does a Microsoft Entra provider require?”
Tell an agent
Create a Microsoft Entra provider {name} for tenant {tenant_id} with client ID {client_id} and secret {client_secret}.
Set up Entra sync {name} in dry-run {dry_run} using tenant {tenant_id}, client {client_id}, secret {client_secret}.
GET /providers/microsoft_entra/{id}/ Get a Microsoft Entra provider · Providers microsoft entra retrieve #
Ask an LLM
“Which Entra tenant is a specific provider syncing to?”
“What group delete action does my Microsoft Entra provider use?”
Tell an agent
Get Microsoft Entra provider {id}.
Show the configuration of Entra provider {id}.
PUT /providers/microsoft_entra/{id}/ Replace a Microsoft Entra provider's config · Providers microsoft entra update #
Ask an LLM
“Can I fully replace an Entra provider's tenant, client and secret at once?”
“How do I overwrite all settings of a Microsoft Entra sync provider?”
Tell an agent
Replace Entra provider {id} with name {name}, tenant {tenant_id}, client {client_id}, secret {client_secret}.
Overwrite Microsoft Entra provider {id} config: {name}, tenant {tenant_id}, app {client_id}, secret {client_secret}.
PATCH /providers/microsoft_entra/{id}/ Update some Microsoft Entra provider settings · Providers microsoft entra partial update #
Ask an LLM
“Can I rotate only the client secret on my Entra provider?”
“How do I switch a Microsoft Entra provider out of dry-run mode?”
Tell an agent
Update the client secret of Entra provider {id} to {client_secret}.
Set dry run to {dry_run} on Microsoft Entra provider {id}.
DELETE /providers/microsoft_entra/{id}/ Delete a Microsoft Entra provider · Providers microsoft entra destroy #
Ask an LLM
“Can I delete a Microsoft Entra sync provider?”
“What happens to Entra syncing when I remove its provider?”
Tell an agent destructive · confirm first
Delete Microsoft Entra provider {id}.
Remove the Entra sync provider {id}.
POST /providers/microsoft_entra/{id}/sync/object/ Re-sync one user or group to Microsoft Entra · Providers microsoft entra sync object create #
Ask an LLM
“Can I push just one user to Entra ID without a full sync?”
“Is there a way to re-sync a single group to Microsoft Entra on demand?”
Tell an agent
Sync {sync_object_model} {sync_object_id} to Microsoft Entra provider {id}.
Re-sync object {sync_object_id} ({sync_object_model}) through Entra provider {id} with dry-run override {override_dry_run}.
GET /providers/microsoft_entra/{id}/sync/status/ Check a Microsoft Entra provider's sync status · Providers microsoft entra sync status retrieve #
Ask an LLM
“Is my Microsoft Entra sync still running?”
“When did the Entra provider last finish syncing?”
Tell an agent
Check the sync status of Microsoft Entra provider {id}.
Show whether Entra provider {id} is currently syncing.
GET /providers/microsoft_entra/{id}/used_by/ See what uses a Microsoft Entra provider · Providers microsoft entra used by list #
Ask an LLM
“What objects reference my Microsoft Entra provider?”
“Is an Entra sync provider still attached to any application?”
Tell an agent
List objects that use Microsoft Entra provider {id}.
Show dependents of Entra provider {id}.
GET /providers/microsoft_entra_groups/ List groups synced to Microsoft Entra · Providers microsoft entra groups list #
Ask an LLM
“Which authentik groups are linked to Entra ID groups?”
“Can I look up the Entra group mapped to a given group UUID?”
Tell an agent
List Microsoft Entra group mappings.
Show Entra group links for authentik group {group_name}.
POST /providers/microsoft_entra_groups/ Link a group to a Microsoft Entra group · Providers microsoft entra groups create #
Ask an LLM
“How do I manually map an authentik group to an existing Entra group object ID?”
“Can I create an Entra group link by hand?”
Tell an agent
Link group {group} to Entra group {microsoft_id} on provider {provider}.
Create a Microsoft Entra group mapping: Microsoft ID {microsoft_id}, group {group}, provider {provider}.
GET /providers/microsoft_entra_groups/{id}/ Get a Microsoft Entra group mapping · Providers microsoft entra groups retrieve #
Ask an LLM
“Which Entra group object does this mapping record point to?”
“What authentik group sits behind a given Entra group link?”
Tell an agent
Get Microsoft Entra group mapping {id}.
Show the Entra group link {id}.
DELETE /providers/microsoft_entra_groups/{id}/ Remove a Microsoft Entra group mapping · Providers microsoft entra groups destroy #
Ask an LLM
“Can I unlink an authentik group from its Entra group?”
“Is it safe to delete a stale Microsoft Entra group mapping?”
Tell an agent destructive · confirm first
Delete Microsoft Entra group mapping {id}.
Unlink the Entra group mapping {id}.
GET /providers/microsoft_entra_groups/{id}/used_by/ See what uses a Microsoft Entra group mapping · Providers microsoft entra groups used by list #
Ask an LLM
“Does anything reference this Entra group mapping?”
“What depends on a Microsoft Entra group link?”
Tell an agent
List objects using Microsoft Entra group mapping {id}.
Show dependents of the Entra group link {id}.
GET /providers/microsoft_entra_users/ List users synced to Microsoft Entra · Providers microsoft entra users list #
Ask an LLM
“Which authentik users have been provisioned into Entra ID?”
“Can I check whether a username has an Entra user link?”
Tell an agent
List Microsoft Entra user mappings.
Find the Entra user link for username {username}.
POST /providers/microsoft_entra_users/ Link a user to a Microsoft Entra account · Providers microsoft entra users create #
Ask an LLM
“How do I map an authentik user to an existing Entra user object ID?”
“Can I add a Microsoft Entra user link manually?”
Tell an agent
Link user {user} to Entra user {microsoft_id} on provider {provider}.
Create a Microsoft Entra user mapping for Microsoft ID {microsoft_id}, user {user}, provider {provider}.
GET /providers/microsoft_entra_users/{id}/ Get a Microsoft Entra user mapping · Providers microsoft entra users retrieve #
Ask an LLM
“Which Entra account is a specific user mapping tied to?”
“What does one Microsoft Entra user link record hold?”
Tell an agent
Get Microsoft Entra user mapping {id}.
Show the Entra user link {id}.
DELETE /providers/microsoft_entra_users/{id}/ Remove a Microsoft Entra user mapping · Providers microsoft entra users destroy #
Ask an LLM
“Can I unlink a user from their Entra account record?”
“Is it possible to delete an outdated Microsoft Entra user mapping?”
Tell an agent destructive · confirm first
Delete Microsoft Entra user mapping {id}.
Unlink the Entra user mapping {id}.
GET /providers/microsoft_entra_users/{id}/used_by/ See what uses a Microsoft Entra user mapping · Providers microsoft entra users used by list #
Ask an LLM
“Does anything reference this Entra user mapping?”
“What depends on a Microsoft Entra user link?”
Tell an agent
List objects using Microsoft Entra user mapping {id}.
Show dependents of the Entra user link {id}.
GET /providers/oauth2/ List OAuth2/OpenID providers · Providers oauth2 list #
Ask an LLM
“Which OAuth2 and OpenID Connect providers have I configured?”
“Can I find the OAuth2 provider that owns a particular client ID?”
Tell an agent
List my OAuth2 providers.
Find the OAuth2 provider with client ID {client_id}.
POST /providers/oauth2/ Create an OAuth2/OpenID provider · Providers oauth2 create #
Ask an LLM
“How do I add OpenID Connect login for a new app in authentik?”
“Can I set access and refresh token lifetimes when creating an OAuth2 provider?”
Tell an agent
Create an OAuth2 provider {name} with redirect URIs {redirect_uris}, authorization flow {authorization_flow} and invalidation flow {invalidation_flow}.
Set up a {client_type} OIDC provider {name} redirecting to {redirect_uris}, flows {authorization_flow} and {invalidation_flow}.
GET /providers/oauth2-dcr/ List OAuth2 dynamic client registration configs · Providers oauth2 dcr list #
Ask an LLM
“Which OAuth2 providers allow dynamic client registration?”
“Can I see the DCR settings attached to a given OAuth2 provider?”
Tell an agent
List OAuth2 dynamic client registration configurations.
Show the DCR config for OAuth2 provider {provider}.
POST /providers/oauth2-dcr/ Enable dynamic client registration · Providers oauth2 dcr create #
Ask an LLM
“How do I let clients register themselves dynamically against an OAuth2 provider?”
“Can dynamically registered clients get a default application group and restricted grant types?”
Tell an agent
Enable dynamic client registration on OAuth2 provider {provider}.
Create a DCR config for provider {provider} allowing grant types {allowed_grant_types}.
GET /providers/oauth2-dcr/{pbm_uuid}/ Get a dynamic client registration config · Providers oauth2 dcr retrieve #
Ask an LLM
“What token validity do dynamically registered clients get under a DCR config?”
“Which grant types does a specific DCR configuration allow?”
Tell an agent
Get dynamic client registration config {pbm_uuid}.
Show DCR settings {pbm_uuid}.
PUT /providers/oauth2-dcr/{pbm_uuid}/ Replace a dynamic client registration config · Providers oauth2 dcr update #
Ask an LLM
“Can I overwrite a whole DCR configuration in one call?”
“How do I fully reset the dynamic registration settings for a provider?”
Tell an agent
Replace DCR config {pbm_uuid} for OAuth2 provider {provider}.
Overwrite dynamic registration config {pbm_uuid}: provider {provider}, policy mode {policy_engine_mode}.
PATCH /providers/oauth2-dcr/{pbm_uuid}/ Update some dynamic client registration settings · Providers oauth2 dcr partial update #
Ask an LLM
“Can I shorten the access token lifetime just for dynamically registered clients?”
“How do I change only the allowed grant types in a DCR config?”
Tell an agent
Set access token validity {access_token_validity} on DCR config {pbm_uuid}.
Restrict DCR config {pbm_uuid} to grant types {allowed_grant_types}.
DELETE /providers/oauth2-dcr/{pbm_uuid}/ Disable dynamic client registration · Providers oauth2 dcr destroy #
Ask an LLM
“How can I stop clients from registering dynamically with an OAuth2 provider?”
“Can I delete a DCR configuration?”
Tell an agent destructive · confirm first
Delete dynamic client registration config {pbm_uuid}.
Turn off DCR by removing config {pbm_uuid}.
GET /providers/oauth2/{id}/ Get an OAuth2/OpenID provider · Providers oauth2 retrieve #
Ask an LLM
“What redirect URIs and grant types does a specific OAuth2 provider allow?”
“Which signing key is my OIDC provider using for ID tokens?”
Tell an agent
Get OAuth2 provider {id}.
Show the configuration of OIDC provider {id}.
PUT /providers/oauth2/{id}/ Replace an OAuth2 provider's config · Providers oauth2 update #
Ask an LLM
“Can I overwrite every setting on an OAuth2 provider at once?”
“How do I fully reconfigure an existing OIDC provider?”
Tell an agent
Replace OAuth2 provider {id} with name {name}, redirect URIs {redirect_uris}, flows {authorization_flow} and {invalidation_flow}.
Overwrite OIDC provider {id}: {name}, redirects {redirect_uris}, authorization {authorization_flow}, invalidation {invalidation_flow}.
PATCH /providers/oauth2/{id}/ Update some OAuth2 provider settings · Providers oauth2 partial update #
Ask an LLM
“Can I add a redirect URI to an OAuth2 provider without resending everything?”
“How do I change only the access token validity on an OIDC provider?”
Tell an agent
Set the redirect URIs of OAuth2 provider {id} to {redirect_uris}.
Change access token validity on OAuth2 provider {id} to {access_token_validity}.
DELETE /providers/oauth2/{id}/ Delete an OAuth2/OpenID provider · Providers oauth2 destroy #
Ask an LLM
“Can I delete an OAuth2 provider for an app I've retired?”
“Will removing an OIDC provider break logins for its client?”
Tell an agent destructive · confirm first
Delete OAuth2 provider {id}.
Remove the OIDC provider {id}.
GET /providers/oauth2/{id}/preview_user/ Preview a user's OAuth2 claims · Providers oauth2 preview user retrieve #
Ask an LLM
“What claims will an OAuth2 provider send for a particular user?”
“Can I test my OIDC property mappings against a real user before rollout?”
Tell an agent
Preview the user data OAuth2 provider {id} would issue.
Show the OIDC claims provider {id} generates for user {for_user}.
GET /providers/oauth2/{id}/setup_urls/ Get an OAuth2 provider's endpoint URLs · Providers oauth2 setup urls retrieve #
Ask an LLM
“What issuer, authorize and token URLs do I paste into my app for this OIDC provider?”
“Where is the JWKS and userinfo endpoint for my OAuth2 provider?”
Tell an agent
Get the setup URLs for OAuth2 provider {id}.
Show the issuer, token and authorize endpoints of OIDC provider {id}.
GET /providers/oauth2/{id}/used_by/ See what uses an OAuth2 provider · Providers oauth2 used by list #
Ask an LLM
“Which applications are bound to my OAuth2 provider?”
“Does anything still reference this OIDC provider?”
Tell an agent
List objects that use OAuth2 provider {id}.
Show dependents of OIDC provider {id}.
GET /providers/proxy/ List proxy providers · Providers proxy list #
Ask an LLM
“Which proxy providers protect my internal apps?”
“Can I find the proxy provider serving a specific external host?”
Tell an agent
List my proxy providers.
Find the proxy provider for external host {external_host}.
POST /providers/proxy/ Create a proxy provider · Providers proxy create #
Ask an LLM
“How do I put authentik authentication in front of an app with no login of its own?”
“Can a proxy provider pass HTTP basic auth to the upstream app?”
Tell an agent
Create a proxy provider {name} for external host {external_host} with flows {authorization_flow} and {invalidation_flow}.
Set up proxy {name} forwarding {external_host} to internal host {internal_host}, flows {authorization_flow} and {invalidation_flow}.
GET /providers/proxy/{id}/ Get a proxy provider · Providers proxy retrieve #
Ask an LLM
“Which internal host does a specific proxy provider forward to?”
“What paths does my proxy provider skip authentication for?”
Tell an agent
Get proxy provider {id}.
Show the settings of proxy provider {id}.
PUT /providers/proxy/{id}/ Replace a proxy provider's config · Providers proxy update #
Ask an LLM
“Can I overwrite a proxy provider's hosts and flows all at once?”
“How do I fully reconfigure an existing proxy provider?”
Tell an agent
Replace proxy provider {id} with name {name}, external host {external_host}, flows {authorization_flow} and {invalidation_flow}.
Overwrite proxy {id}: {name}, public URL {external_host}, authorization {authorization_flow}, invalidation {invalidation_flow}.
PATCH /providers/proxy/{id}/ Update some proxy provider settings · Providers proxy partial update #
Ask an LLM
“Can I change only the skip-path regex on a proxy provider?”
“How do I switch a proxy provider to forward-auth mode?”
Tell an agent
Set the unauthenticated path regex on proxy provider {id} to {skip_path_regex}.
Change proxy provider {id} to mode {mode}.
DELETE /providers/proxy/{id}/ Delete a proxy provider · Providers proxy destroy #
Ask an LLM
“Can I remove a proxy provider for an app I've taken offline?”
“Does deleting a proxy provider stop the outpost from protecting that host?”
Tell an agent destructive · confirm first
Delete proxy provider {id}.
Remove the proxy provider {id}.
GET /providers/proxy/{id}/used_by/ See what uses a proxy provider · Providers proxy used by list #
Ask an LLM
“Which applications or outposts use my proxy provider?”
“Is a proxy provider still referenced before I delete it?”
Tell an agent
List objects that use proxy provider {id}.
Show dependents of proxy provider {id}.
GET /providers/rac/ List remote access (RAC) providers · Providers rac list #
Ask an LLM
“Which remote access providers for RDP, SSH or VNC have I set up?”
“Are any RAC providers not yet attached to an application?”
Tell an agent
List my RAC remote access providers.
Find RAC providers named {name}.
POST /providers/rac/ Create a remote access (RAC) provider · Providers rac create #
Ask an LLM
“How do I give users browser-based RDP or SSH access through authentik?”
“Can a new RAC provider delete the connection token when the user disconnects?”
Tell an agent
Create a RAC provider {name} with authorization flow {authorization_flow}.
Set up remote access provider {name} using flow {authorization_flow} with connection expiry {connection_expiry}.
GET /providers/rac/{id}/ Get a remote access (RAC) provider · Providers rac retrieve #
Ask an LLM
“How long do connections last on a specific RAC provider?”
“What connection settings does my remote access provider pass along?”
Tell an agent
Get RAC provider {id}.
Show the settings of remote access provider {id}.
PUT /providers/rac/{id}/ Replace a RAC provider's config · Providers rac update #
Ask an LLM
“Can I overwrite every setting of a remote access provider at once?”
“How do I fully reconfigure a RAC provider?”
Tell an agent
Replace RAC provider {id} with name {name} and authorization flow {authorization_flow}.
Overwrite remote access provider {id}: name {name}, flow {authorization_flow}, settings {settings}.
PATCH /providers/rac/{id}/ Update some RAC provider settings · Providers rac partial update #
Ask an LLM
“Can I change just the connection expiry on a remote access provider?”
“How do I make a RAC provider drop its token on disconnect?”
Tell an agent
Set connection expiry on RAC provider {id} to {connection_expiry}.
Set delete-token-on-disconnect to {delete_token_on_disconnect} for RAC provider {id}.
DELETE /providers/rac/{id}/ Delete a remote access (RAC) provider · Providers rac destroy #
Ask an LLM
“Can I remove a RAC provider for machines I've decommissioned?”
“What happens to remote desktop access when its RAC provider is deleted?”
Tell an agent destructive · confirm first
Delete RAC provider {id}.
Remove the remote access provider {id}.
GET /providers/rac/{id}/used_by/ See what uses a RAC provider · Providers rac used by list #
Ask an LLM
“Which applications or endpoints depend on my remote access provider?”
“Is a RAC provider still in use anywhere?”
Tell an agent
List objects that use RAC provider {id}.
Show dependents of remote access provider {id}.
GET /providers/radius/ List RADIUS providers · Providers radius list #
Ask an LLM
“Which RADIUS providers authenticate my network devices?”
“Can I find RADIUS providers by the client networks they accept?”
Tell an agent
List my RADIUS providers.
Find RADIUS providers allowing client networks {client_networks}.
POST /providers/radius/ Create a RADIUS provider · Providers radius create #
Ask an LLM
“How do I let a VPN or Wi-Fi controller authenticate users against authentik over RADIUS?”
“Can a new RADIUS provider require MFA?”
Tell an agent
Create a RADIUS provider {name} with flows {authorization_flow} and {invalidation_flow}.
Set up RADIUS provider {name} with shared secret {shared_secret} for networks {client_networks}, flows {authorization_flow} and {invalidation_flow}.
GET /providers/radius/{id}/ Get a RADIUS provider · Providers radius retrieve #
Ask an LLM
“Which client networks may talk to a specific RADIUS provider?”
“Is MFA support enabled on my RADIUS provider?”
Tell an agent
Get RADIUS provider {id}.
Show the settings of RADIUS provider {id}.
PUT /providers/radius/{id}/ Replace a RADIUS provider's config · Providers radius update #
Ask an LLM
“Can I overwrite all settings of a RADIUS provider in one go?”
“How do I fully reconfigure an existing RADIUS provider?”
Tell an agent
Replace RADIUS provider {id} with name {name}, flows {authorization_flow} and {invalidation_flow}.
Overwrite RADIUS provider {id}: {name}, secret {shared_secret}, authorization {authorization_flow}, invalidation {invalidation_flow}.
PATCH /providers/radius/{id}/ Update some RADIUS provider settings · Providers radius partial update #
Ask an LLM
“Can I rotate only the shared secret on a RADIUS provider?”
“How do I change the allowed client networks for RADIUS?”
Tell an agent
Set the shared secret of RADIUS provider {id} to {shared_secret}.
Allow client networks {client_networks} on RADIUS provider {id}.
DELETE /providers/radius/{id}/ Delete a RADIUS provider · Providers radius destroy #
Ask an LLM
“Can I remove a RADIUS provider I no longer use?”
“Will deleting a RADIUS provider cut off my network devices' logins?”
Tell an agent destructive · confirm first
Delete RADIUS provider {id}.
Remove the RADIUS provider {id}.
GET /providers/radius/{id}/used_by/ See what uses a RADIUS provider · Providers radius used by list #
Ask an LLM
“Which applications or outposts depend on my RADIUS provider?”
“Is a RADIUS provider still referenced anywhere?”
Tell an agent
List objects that use RADIUS provider {id}.
Show dependents of RADIUS provider {id}.
GET /providers/saml/ List SAML providers · Providers saml list #
Ask an LLM
“Which SAML service provider integrations are configured?”
“Can I find the SAML provider that posts to a particular ACS URL?”
Tell an agent
List my SAML providers.
Find the SAML provider with ACS URL {acs_url}.
POST /providers/saml/ Create a SAML provider · Providers saml create #
Ask an LLM
“How do I set up SAML single sign-on for a service provider by hand?”
“Can I choose signing and encryption keys when creating a SAML provider?”
Tell an agent
Create a SAML provider {name} with ACS URL {acs_url}, flows {authorization_flow} and {invalidation_flow}.
Set up SAML provider {name} for audience {audience}, ACS {acs_url}, signed with {signing_kp}, flows {authorization_flow} and {invalidation_flow}.
GET /providers/saml/{id}/ Get a SAML provider · Providers saml retrieve #
Ask an LLM
“What ACS URL and audience is a specific SAML provider configured with?”
“Which signature algorithm does my SAML provider use?”
Tell an agent
Get SAML provider {id}.
Show the configuration of SAML provider {id}.
PUT /providers/saml/{id}/ Replace a SAML provider's config · Providers saml update #
Ask an LLM
“Can I overwrite a SAML provider's entire configuration at once?”
“How do I fully reconfigure an existing SAML integration?”
Tell an agent
Replace SAML provider {id} with name {name}, ACS URL {acs_url}, flows {authorization_flow} and {invalidation_flow}.
Overwrite SAML provider {id}: {name}, ACS {acs_url}, authorization {authorization_flow}, invalidation {invalidation_flow}.
PATCH /providers/saml/{id}/ Update some SAML provider settings · Providers saml partial update #
Ask an LLM
“Can I change only the ACS URL on my SAML provider?”
“How do I turn on assertion signing for an existing SAML provider?”
Tell an agent
Set the ACS URL of SAML provider {id} to {acs_url}.
Set sign assertion to {sign_assertion} on SAML provider {id}.
DELETE /providers/saml/{id}/ Delete a SAML provider · Providers saml destroy #
Ask an LLM
“Can I delete a SAML integration for a retired service?”
“Will removing a SAML provider stop SSO into that service provider?”
Tell an agent destructive · confirm first
Delete SAML provider {id}.
Remove the SAML provider {id}.
GET /providers/saml/{id}/metadata/ Download SAML IdP metadata · Providers saml metadata retrieve #
Ask an LLM
“Where do I get the SAML metadata XML to give my service provider?”
“Can I download SAML metadata forced to a specific binding?”
Tell an agent
Get the SAML metadata XML for provider {id}.
Download SAML metadata for provider {id} with binding {force_binding}.
GET /providers/saml/{id}/preview_user/ Preview a user's SAML attributes · Providers saml preview user retrieve #
Ask an LLM
“What SAML attributes will be sent for a given user?”
“Can I test SAML property mappings against a user before going live?”
Tell an agent
Preview the user data SAML provider {id} would assert.
Show SAML attributes provider {id} generates for user {for_user}.
GET /providers/saml/{id}/used_by/ See what uses a SAML provider · Providers saml used by list #
Ask an LLM
“Which applications are bound to my SAML provider?”
“Does anything still reference this SAML integration?”
Tell an agent
List objects that use SAML provider {id}.
Show dependents of SAML provider {id}.
POST /providers/saml/import_metadata/ Create a SAML provider from SP metadata · Providers saml import metadata create #
Ask an LLM
“Can I create a SAML provider by uploading the service provider's metadata file?”
“How do I import SP metadata XML instead of typing the ACS URL by hand?”
Tell an agent
Import SAML metadata file {file} as provider {name} with flows {authorization_flow} and {invalidation_flow}.
Build SAML provider {name} from uploaded SP metadata {file}, authorization {authorization_flow}, invalidation {invalidation_flow}.
GET /providers/scim/ List SCIM providers · Providers scim list #
Ask an LLM
“Which SCIM outbound provisioning providers are configured?”
“Can I find the SCIM provider pointing at a specific endpoint URL?”
Tell an agent
List my SCIM providers.
Find the SCIM provider with URL {url}.
POST /providers/scim/ Create a SCIM provider · Providers scim create #
Ask an LLM
“How do I provision users into a SaaS app over SCIM from authentik?”
“Can a SCIM provider authenticate with OAuth instead of a static token?”
Tell an agent
Create a SCIM provider {name} pointing at {url}.
Set up SCIM provisioning {name} to {url} with bearer token {token}.
GET /providers/scim/{id}/ Get a SCIM provider · Providers scim retrieve #
Ask an LLM
“Which endpoint URL and auth mode does a specific SCIM provider use?”
“Does my SCIM provider verify the target's certificates?”
Tell an agent
Get SCIM provider {id}.
Show the configuration of SCIM provider {id}.
PUT /providers/scim/{id}/ Replace a SCIM provider's config · Providers scim update #
Ask an LLM
“Can I overwrite a SCIM provider's URL and credentials together?”
“How do I fully reconfigure an existing SCIM provider?”
Tell an agent
Replace SCIM provider {id} with name {name} and URL {url}.
Overwrite SCIM provider {id}: {name}, endpoint {url}, token {token}.
PATCH /providers/scim/{id}/ Update some SCIM provider settings · Providers scim partial update #
Ask an LLM
“Can I rotate only the bearer token on my SCIM provider?”
“How do I turn on compatibility mode for a picky SCIM target?”
Tell an agent
Set the token of SCIM provider {id} to {token}.
Switch SCIM provider {id} to compatibility mode {compatibility_mode}.
DELETE /providers/scim/{id}/ Delete a SCIM provider · Providers scim destroy #
Ask an LLM
“Can I remove a SCIM provider for an app I stopped provisioning?”
“Does deleting a SCIM provider stop outbound provisioning?”
Tell an agent destructive · confirm first
Delete SCIM provider {id}.
Remove the SCIM provider {id}.
POST /providers/scim/{id}/sync/object/ Re-sync one user or group over SCIM · Providers scim sync object create #
Ask an LLM
“Can I push a single user to a SCIM target without a full sync?”
“Is there a way to re-provision just one group over SCIM?”
Tell an agent
Sync {sync_object_model} {sync_object_id} via SCIM provider {id}.
Re-provision object {sync_object_id} ({sync_object_model}) over SCIM provider {id}, dry-run override {override_dry_run}.
GET /providers/scim/{id}/sync/status/ Check a SCIM provider's sync status · Providers scim sync status retrieve #
Ask an LLM
“Is my SCIM provisioning sync running right now?”
“When did the last SCIM sync finish?”
Tell an agent
Check the sync status of SCIM provider {id}.
Show whether SCIM provider {id} is currently syncing.
GET /providers/scim/{id}/used_by/ See what uses a SCIM provider · Providers scim used by list #
Ask an LLM
“Which applications reference my SCIM provider?”
“Is a SCIM provider still attached anywhere?”
Tell an agent
List objects that use SCIM provider {id}.
Show dependents of SCIM provider {id}.
GET /providers/scim_groups/ List groups provisioned over SCIM · Providers scim groups list #
Ask an LLM
“Which authentik groups have been pushed to SCIM targets?”
“Can I find the SCIM group record for a given group name?”
Tell an agent
List SCIM group mappings.
Show SCIM group links for authentik group {group_name}.
POST /providers/scim_groups/ Link a group to a SCIM group ID · Providers scim groups create #
Ask an LLM
“How do I record that an authentik group already exists in the SCIM target?”
“Can I manually create a SCIM group mapping?”
Tell an agent
Link group {group} to SCIM group {scim_id} on provider {provider}.
Create a SCIM group mapping: SCIM ID {scim_id}, group {group}, provider {provider}.
GET /providers/scim_groups/{id}/ Get a SCIM group mapping · Providers scim groups retrieve #
Ask an LLM
“Which remote SCIM group ID does this mapping point to?”
“What authentik group is behind a SCIM group record?”
Tell an agent
Get SCIM group mapping {id}.
Show the SCIM group link {id}.
DELETE /providers/scim_groups/{id}/ Remove a SCIM group mapping · Providers scim groups destroy #
Ask an LLM
“Can I unlink a group from its SCIM target record?”
“Is it safe to delete a stale SCIM group mapping?”
Tell an agent destructive · confirm first
Delete SCIM group mapping {id}.
Unlink the SCIM group mapping {id}.
GET /providers/scim_groups/{id}/used_by/ See what uses a SCIM group mapping · Providers scim groups used by list #
Ask an LLM
“Does anything reference this SCIM group mapping?”
“What depends on a SCIM group link?”
Tell an agent
List objects using SCIM group mapping {id}.
Show dependents of the SCIM group link {id}.
GET /providers/scim_users/ List users provisioned over SCIM · Providers scim users list #
Ask an LLM
“Which authentik users have been provisioned to SCIM targets?”
“Can I check whether a username has a SCIM user record?”
Tell an agent
List SCIM user mappings.
Find the SCIM user link for username {username}.
POST /providers/scim_users/ Link a user to a SCIM user ID · Providers scim users create #
Ask an LLM
“How do I record that a user already exists in the SCIM target?”
“Can I manually add a SCIM user mapping?”
Tell an agent
Link user {user} to SCIM user {scim_id} on provider {provider}.
Create a SCIM user mapping for SCIM ID {scim_id}, user {user}, provider {provider}.
GET /providers/scim_users/{id}/ Get a SCIM user mapping · Providers scim users retrieve #
Ask an LLM
“Which remote SCIM user ID is a given mapping tied to?”
“What does a single SCIM user link record contain?”
Tell an agent
Get SCIM user mapping {id}.
Show the SCIM user link {id}.
DELETE /providers/scim_users/{id}/ Remove a SCIM user mapping · Providers scim users destroy #
Ask an LLM
“Can I unlink a user from their SCIM target record?”
“Is it possible to delete an outdated SCIM user mapping?”
Tell an agent destructive · confirm first
Delete SCIM user mapping {id}.
Unlink the SCIM user mapping {id}.
GET /providers/scim_users/{id}/used_by/ See what uses a SCIM user mapping · Providers scim users used by list #
Ask an LLM
“Does anything reference this SCIM user mapping?”
“What depends on a SCIM user link?”
Tell an agent
List objects using SCIM user mapping {id}.
Show dependents of the SCIM user link {id}.
GET /providers/ssf/ List Shared Signals (SSF) providers · Providers ssf list #
Ask an LLM
“Which Shared Signals Framework providers are configured?”
“Are any SSF providers not attached to an application?”
Tell an agent
List my SSF providers.
Find SSF providers named {name}.
POST /providers/ssf/ Create a Shared Signals (SSF) provider · Providers ssf create #
Ask an LLM
“How do I broadcast security events to receivers with the Shared Signals Framework?”
“What signing key does a new SSF provider need?”
Tell an agent
Create an SSF provider {name} signing with key {signing_key}.
Set up Shared Signals provider {name} with key {signing_key} and event retention {event_retention}.
GET /providers/ssf/{id}/ Get a Shared Signals (SSF) provider · Providers ssf retrieve #
Ask an LLM
“How long does a specific SSF provider retain security events?”
“Which OIDC providers can authenticate to my SSF provider?”
Tell an agent
Get SSF provider {id}.
Show the settings of Shared Signals provider {id}.
PUT /providers/ssf/{id}/ Replace an SSF provider's config · Providers ssf update #
Ask an LLM
“Can I overwrite every setting of an SSF provider at once?”
“How do I fully reconfigure a Shared Signals provider?”
Tell an agent
Replace SSF provider {id} with name {name} and signing key {signing_key}.
Overwrite Shared Signals provider {id}: {name}, key {signing_key}, retention {event_retention}.
PATCH /providers/ssf/{id}/ Update some SSF provider settings · Providers ssf partial update #
Ask an LLM
“Can I change only the event retention on my SSF provider?”
“How do I stop an SSF provider verifying push receivers' certificates?”
Tell an agent
Set event retention on SSF provider {id} to {event_retention}.
Set push certificate verification {push_verify_certificates} on SSF provider {id}.
DELETE /providers/ssf/{id}/ Delete a Shared Signals (SSF) provider · Providers ssf destroy #
Ask an LLM
“Can I remove an SSF provider I no longer need?”
“Will deleting a Shared Signals provider stop event delivery to receivers?”
Tell an agent destructive · confirm first
Delete SSF provider {id}.
Remove the Shared Signals provider {id}.
GET /providers/ssf/{id}/used_by/ See what uses an SSF provider · Providers ssf used by list #
Ask an LLM
“Which applications reference my Shared Signals provider?”
“Is an SSF provider still in use anywhere?”
Tell an agent
List objects that use SSF provider {id}.
Show dependents of Shared Signals provider {id}.
GET /providers/wsfed/ List WS-Federation providers · Providers wsfed list #
Ask an LLM
“Which WS-Federation providers are configured?”
“Can I filter WS-Fed providers by SAML token version or ACS URL?”
Tell an agent
List my WS-Federation providers.
Show WS-Fed providers using SAML version {saml_version}.
POST /providers/wsfed/ Create a WS-Federation provider · Providers wsfed create #
Ask an LLM
“How do I set up WS-Federation sign-in for an app that needs it, like SharePoint?”
“What reply URL and realm does a new WS-Fed provider need?”
Tell an agent
Create a WS-Federation provider {name} with reply URL {reply_url}, realm {wtrealm}, flows {authorization_flow} and {invalidation_flow}.
Set up WS-Fed {name} for realm {wtrealm} replying to {reply_url}, token version {saml_version}, flows {authorization_flow}/{invalidation_flow}.
GET /providers/wsfed/{id}/ Get a WS-Federation provider · Providers wsfed retrieve #
Ask an LLM
“What realm and reply URL does a specific WS-Fed provider use?”
“Which signing key does my WS-Federation provider use?”
Tell an agent
Get WS-Federation provider {id}.
Show the configuration of WS-Fed provider {id}.
PUT /providers/wsfed/{id}/ Replace a WS-Federation provider's config · Providers wsfed update #
Ask an LLM
“Can I overwrite a WS-Federation provider's whole configuration?”
“How do I fully reconfigure an existing WS-Fed integration?”
Tell an agent
Replace WS-Federation provider {id} with name {name}, reply URL {reply_url}, realm {wtrealm}, flows {authorization_flow} and {invalidation_flow}.
Overwrite WS-Fed provider {id}: {name}, realm {wtrealm}, reply {reply_url}, flows {authorization_flow}/{invalidation_flow}.
PATCH /providers/wsfed/{id}/ Update some WS-Federation provider settings · Providers wsfed partial update #
Ask an LLM
“Can I change only the reply URL of a WS-Fed provider?”
“How do I switch the SAML token version a WS-Federation provider issues?”
Tell an agent
Set the reply URL of WS-Federation provider {id} to {reply_url}.
Change the SAML version of WS-Fed provider {id} to {saml_version}.
DELETE /providers/wsfed/{id}/ Delete a WS-Federation provider · Providers wsfed destroy #
Ask an LLM
“Can I delete a WS-Federation integration I've retired?”
“Will removing a WS-Fed provider break sign-in for its relying party?”
Tell an agent destructive · confirm first
Delete WS-Federation provider {id}.
Remove the WS-Fed provider {id}.
GET /providers/wsfed/{id}/metadata/ Download WS-Federation metadata · Providers wsfed metadata retrieve #
Ask an LLM
“Where do I get the federation metadata XML for my WS-Fed relying party?”
“Can I download WS-Federation metadata as a file?”
Tell an agent
Get the WS-Federation metadata XML for provider {id}.
Download WS-Fed metadata for provider {id} as a file: {download}.
GET /providers/wsfed/{id}/preview_user/ Preview a user's WS-Federation claims · Providers wsfed preview user retrieve #
Ask an LLM
“What claims will a WS-Federation provider send for a given user?”
“Can I test WS-Fed property mappings against a real user?”
Tell an agent
Preview the user data WS-Federation provider {id} would send.
Show WS-Fed claims provider {id} generates for user {for_user}.
GET /providers/wsfed/{id}/used_by/ See what uses a WS-Federation provider · Providers wsfed used by list #
Ask an LLM
“Which applications are bound to my WS-Federation provider?”
“Does anything still reference this WS-Fed integration?”
Tell an agent
List objects that use WS-Federation provider {id}.
Show dependents of WS-Fed provider {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-providers-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-providers-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-providers-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-providers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: authentik Providers 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 (262 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/authentik/refs/heads/main/openapi/authentik-providers-api-openapi.yml