How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Authentik Sources API

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

Authentik Sources API is one of 27 APIs that Authentik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sources. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a GitHub repository.

This API exposes 173 operations across 82 paths, and defines 135 schemas. It is described by OpenAPI 3.2.0, at version 2026.11.0-rc1.

Requests are made against a single base URL, /api/v3.

173 operations 82 paths 135 schemas 24 DELETE79 GET23 PATCH24 POST23 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.11.0-rc1
Base URL
https://{authentik_host}/api/v3
Authentication
HTTP Bearer, HTTP Bearer+Agent, HTTP Bearer, HTTP Bearer
License
Resource Areas
1

Authentication & Security 4

Authentik Sources API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (authentik). It uses HTTP bearer+agent authentication (authentik_device_auth). It accepts HTTP bearer tokens (authentik_device_enroll). It accepts HTTP bearer tokens (authentik_device_federation).

Paths & Operations 173

Across 82 paths, the API surfaces 173 operations — 24 DELETE, 79 GET, 23 PATCH, 24 POST, 23 PUT. Each is listed below with its method, path, parameters, and response codes.

sources 173
GET
/sources/all/
Source Viewset
sources_all_list 8 params → 200400403
GET
/sources/all/{slug}/
Source Viewset
sources_all_retrieve 1 param → 200400403
DELETE
/sources/all/{slug}/
Prevent deletion of built-in sources
sources_all_destroy 1 param → 204400403
GET
/sources/all/{slug}/used_by/
Get a list of all objects that use this object
sources_all_used_by_list 1 param → 200400403
GET
/sources/all/types/
Get all creatable types
sources_all_types_list → 200400403
GET
/sources/all/user_settings/
Get all sources the user can configure
sources_all_user_settings_list → 200400403
GET
/sources/group_connections/all/
Group-source connection Viewset
sources_group_connections_all_list 6 params → 200400403
GET
/sources/group_connections/all/{id}/
Group-source connection Viewset
sources_group_connections_all_retrieve 1 param → 200400403
PUT
/sources/group_connections/all/{id}/
Group-source connection Viewset
sources_group_connections_all_update 1 param body → 200400403
PATCH
/sources/group_connections/all/{id}/
Group-source connection Viewset
sources_group_connections_all_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/all/{id}/
Group-source connection Viewset
sources_group_connections_all_destroy 1 param → 204400403
GET
/sources/group_connections/all/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_all_used_by_list 1 param → 200400403
GET
/sources/group_connections/kerberos/
Group-source connection Viewset
sources_group_connections_kerberos_list 6 params → 200400403
POST
/sources/group_connections/kerberos/
Group-source connection Viewset
sources_group_connections_kerberos_create body → 201400403
GET
/sources/group_connections/kerberos/{id}/
Group-source connection Viewset
sources_group_connections_kerberos_retrieve 1 param → 200400403
PUT
/sources/group_connections/kerberos/{id}/
Group-source connection Viewset
sources_group_connections_kerberos_update 1 param body → 200400403
PATCH
/sources/group_connections/kerberos/{id}/
Group-source connection Viewset
sources_group_connections_kerberos_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/kerberos/{id}/
Group-source connection Viewset
sources_group_connections_kerberos_destroy 1 param → 204400403
GET
/sources/group_connections/kerberos/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_kerberos_used_by_list 1 param → 200400403
GET
/sources/group_connections/ldap/
Group-source connection Viewset
sources_group_connections_ldap_list 6 params → 200400403
POST
/sources/group_connections/ldap/
Group-source connection Viewset
sources_group_connections_ldap_create body → 201400403
GET
/sources/group_connections/ldap/{id}/
Group-source connection Viewset
sources_group_connections_ldap_retrieve 1 param → 200400403
PUT
/sources/group_connections/ldap/{id}/
Group-source connection Viewset
sources_group_connections_ldap_update 1 param body → 200400403
PATCH
/sources/group_connections/ldap/{id}/
Group-source connection Viewset
sources_group_connections_ldap_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/ldap/{id}/
Group-source connection Viewset
sources_group_connections_ldap_destroy 1 param → 204400403
GET
/sources/group_connections/ldap/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_ldap_used_by_list 1 param → 200400403
GET
/sources/group_connections/oauth/
Group-source connection Viewset
sources_group_connections_oauth_list 6 params → 200400403
POST
/sources/group_connections/oauth/
Group-source connection Viewset
sources_group_connections_oauth_create body → 201400403
GET
/sources/group_connections/oauth/{id}/
Group-source connection Viewset
sources_group_connections_oauth_retrieve 1 param → 200400403
PUT
/sources/group_connections/oauth/{id}/
Group-source connection Viewset
sources_group_connections_oauth_update 1 param body → 200400403
PATCH
/sources/group_connections/oauth/{id}/
Group-source connection Viewset
sources_group_connections_oauth_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/oauth/{id}/
Group-source connection Viewset
sources_group_connections_oauth_destroy 1 param → 204400403
GET
/sources/group_connections/oauth/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_oauth_used_by_list 1 param → 200400403
GET
/sources/group_connections/plex/
Group-source connection Viewset
sources_group_connections_plex_list 6 params → 200400403
POST
/sources/group_connections/plex/
Group-source connection Viewset
sources_group_connections_plex_create body → 201400403
GET
/sources/group_connections/plex/{id}/
Group-source connection Viewset
sources_group_connections_plex_retrieve 1 param → 200400403
PUT
/sources/group_connections/plex/{id}/
Group-source connection Viewset
sources_group_connections_plex_update 1 param body → 200400403
PATCH
/sources/group_connections/plex/{id}/
Group-source connection Viewset
sources_group_connections_plex_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/plex/{id}/
Group-source connection Viewset
sources_group_connections_plex_destroy 1 param → 204400403
GET
/sources/group_connections/plex/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_plex_used_by_list 1 param → 200400403
GET
/sources/group_connections/saml/
Group-source connection Viewset
sources_group_connections_saml_list 6 params → 200400403
POST
/sources/group_connections/saml/
Group-source connection Viewset
sources_group_connections_saml_create body → 201400403
GET
/sources/group_connections/saml/{id}/
Group-source connection Viewset
sources_group_connections_saml_retrieve 1 param → 200400403
PUT
/sources/group_connections/saml/{id}/
Group-source connection Viewset
sources_group_connections_saml_update 1 param body → 200400403
PATCH
/sources/group_connections/saml/{id}/
Group-source connection Viewset
sources_group_connections_saml_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/saml/{id}/
Group-source connection Viewset
sources_group_connections_saml_destroy 1 param → 204400403
GET
/sources/group_connections/saml/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_saml_used_by_list 1 param → 200400403
GET
/sources/group_connections/telegram/
Group-source connection Viewset
sources_group_connections_telegram_list 6 params → 200400403
POST
/sources/group_connections/telegram/
Group-source connection Viewset
sources_group_connections_telegram_create body → 201400403
GET
/sources/group_connections/telegram/{id}/
Group-source connection Viewset
sources_group_connections_telegram_retrieve 1 param → 200400403
PUT
/sources/group_connections/telegram/{id}/
Group-source connection Viewset
sources_group_connections_telegram_update 1 param body → 200400403
PATCH
/sources/group_connections/telegram/{id}/
Group-source connection Viewset
sources_group_connections_telegram_partial_update 1 param body → 200400403
DELETE
/sources/group_connections/telegram/{id}/
Group-source connection Viewset
sources_group_connections_telegram_destroy 1 param → 204400403
GET
/sources/group_connections/telegram/{id}/used_by/
Get a list of all objects that use this object
sources_group_connections_telegram_used_by_list 1 param → 200400403
GET
/sources/kerberos/
Kerberos Source Viewset
sources_kerberos_list 15 params → 200400403
POST
/sources/kerberos/
Kerberos Source Viewset
sources_kerberos_create body → 201400403
GET
/sources/kerberos/{slug}/
Kerberos Source Viewset
sources_kerberos_retrieve 1 param → 200400403
PUT
/sources/kerberos/{slug}/
Kerberos Source Viewset
sources_kerberos_update 1 param body → 200400403
PATCH
/sources/kerberos/{slug}/
Kerberos Source Viewset
sources_kerberos_partial_update 1 param body → 200400403
DELETE
/sources/kerberos/{slug}/
Kerberos Source Viewset
sources_kerberos_destroy 1 param → 204400403
GET
/sources/kerberos/{slug}/sync/status/
Get provider's sync status
sources_kerberos_sync_status_retrieve 1 param → 200400403
GET
/sources/kerberos/{slug}/used_by/
Get a list of all objects that use this object
sources_kerberos_used_by_list 1 param → 200400403
GET
/sources/ldap/
LDAP Source Viewset
sources_ldap_list 32 params → 200400403
POST
/sources/ldap/
LDAP Source Viewset
sources_ldap_create body → 201400403
GET
/sources/ldap/{slug}/
LDAP Source Viewset
sources_ldap_retrieve 1 param → 200400403
PUT
/sources/ldap/{slug}/
LDAP Source Viewset
sources_ldap_update 1 param body → 200400403
PATCH
/sources/ldap/{slug}/
LDAP Source Viewset
sources_ldap_partial_update 1 param body → 200400403
DELETE
/sources/ldap/{slug}/
LDAP Source Viewset
sources_ldap_destroy 1 param → 204400403
GET
/sources/ldap/{slug}/debug/
Get raw LDAP data to debug
sources_ldap_debug_retrieve 1 param → 200400403
GET
/sources/ldap/{slug}/sync/status/
Get provider's sync status
sources_ldap_sync_status_retrieve 1 param → 200400403
GET
/sources/ldap/{slug}/used_by/
Get a list of all objects that use this object
sources_ldap_used_by_list 1 param → 200400403
GET
/sources/oauth/
Source Viewset
sources_oauth_list 21 params → 200400403
POST
/sources/oauth/
Source Viewset
sources_oauth_create body → 201400403
GET
/sources/oauth/{slug}/
Source Viewset
sources_oauth_retrieve 1 param → 200400403
PUT
/sources/oauth/{slug}/
Source Viewset
sources_oauth_update 1 param body → 200400403
PATCH
/sources/oauth/{slug}/
Source Viewset
sources_oauth_partial_update 1 param body → 200400403
DELETE
/sources/oauth/{slug}/
Source Viewset
sources_oauth_destroy 1 param → 204400403
GET
/sources/oauth/{slug}/used_by/
Get a list of all objects that use this object
sources_oauth_used_by_list 1 param → 200400403
GET
/sources/oauth/source_types/
Get all creatable source types. If ?name is set, only returns the type for . If isn't found, returns the default type.
sources_oauth_source_types_list 1 param → 200400403
GET
/sources/plex/
Plex source Viewset
sources_plex_list 15 params → 200400403
POST
/sources/plex/
Plex source Viewset
sources_plex_create body → 201400403
GET
/sources/plex/{slug}/
Plex source Viewset
sources_plex_retrieve 1 param → 200400403
PUT
/sources/plex/{slug}/
Plex source Viewset
sources_plex_update 1 param body → 200400403
PATCH
/sources/plex/{slug}/
Plex source Viewset
sources_plex_partial_update 1 param body → 200400403
DELETE
/sources/plex/{slug}/
Plex source Viewset
sources_plex_destroy 1 param → 204400403
GET
/sources/plex/{slug}/used_by/
Get a list of all objects that use this object
sources_plex_used_by_list 1 param → 200400403
POST
/sources/plex/redeem_token/
Redeem a plex token, check it's access to resources against what's allowed for the source, and redirect to an authentication/enrollment flow.
sources_plex_redeem_token_create 1 param body → 200400403
POST
/sources/plex/redeem_token_authenticated/
Redeem a plex token for an authenticated user, creating a connection
sources_plex_redeem_token_authenticated_create 1 param body → 204400403
GET
/sources/saml/
SAMLSource Viewset
sources_saml_list 28 params → 200400403
POST
/sources/saml/
SAMLSource Viewset
sources_saml_create body → 201400403
GET
/sources/saml/{slug}/
SAMLSource Viewset
sources_saml_retrieve 1 param → 200400403
PUT
/sources/saml/{slug}/
SAMLSource Viewset
sources_saml_update 1 param body → 200400403
PATCH
/sources/saml/{slug}/
SAMLSource Viewset
sources_saml_partial_update 1 param body → 200400403
DELETE
/sources/saml/{slug}/
SAMLSource Viewset
sources_saml_destroy 1 param → 204400403
GET
/sources/saml/{slug}/metadata/
Return metadata as XML string
sources_saml_metadata_retrieve 1 param → 200400403
GET
/sources/saml/{slug}/used_by/
Get a list of all objects that use this object
sources_saml_used_by_list 1 param → 200400403
GET
/sources/scim/
SCIMSource Viewset
sources_scim_list 7 params → 200400403
POST
/sources/scim/
SCIMSource Viewset
sources_scim_create body → 201400403
GET
/sources/scim/{slug}/
SCIMSource Viewset
sources_scim_retrieve 1 param → 200400403
PUT
/sources/scim/{slug}/
SCIMSource Viewset
sources_scim_update 1 param body → 200400403
PATCH
/sources/scim/{slug}/
SCIMSource Viewset
sources_scim_partial_update 1 param body → 200400403
DELETE
/sources/scim/{slug}/
SCIMSource Viewset
sources_scim_destroy 1 param → 204400403
GET
/sources/scim/{slug}/used_by/
Get a list of all objects that use this object
sources_scim_used_by_list 1 param → 200400403
GET
/sources/scim_groups/
SCIMSourceGroup Viewset
sources_scim_groups_list 7 params → 200400403
POST
/sources/scim_groups/
SCIMSourceGroup Viewset
sources_scim_groups_create body → 201400403
GET
/sources/scim_groups/{id}/
SCIMSourceGroup Viewset
sources_scim_groups_retrieve 1 param → 200400403
PUT
/sources/scim_groups/{id}/
SCIMSourceGroup Viewset
sources_scim_groups_update 1 param body → 200400403
PATCH
/sources/scim_groups/{id}/
SCIMSourceGroup Viewset
sources_scim_groups_partial_update 1 param body → 200400403
DELETE
/sources/scim_groups/{id}/
SCIMSourceGroup Viewset
sources_scim_groups_destroy 1 param → 204400403
GET
/sources/scim_groups/{id}/used_by/
Get a list of all objects that use this object
sources_scim_groups_used_by_list 1 param → 200400403
GET
/sources/scim_users/
SCIMSourceUser Viewset
sources_scim_users_list 7 params → 200400403
POST
/sources/scim_users/
SCIMSourceUser Viewset
sources_scim_users_create body → 201400403
GET
/sources/scim_users/{id}/
SCIMSourceUser Viewset
sources_scim_users_retrieve 1 param → 200400403
PUT
/sources/scim_users/{id}/
SCIMSourceUser Viewset
sources_scim_users_update 1 param body → 200400403
PATCH
/sources/scim_users/{id}/
SCIMSourceUser Viewset
sources_scim_users_partial_update 1 param body → 200400403
DELETE
/sources/scim_users/{id}/
SCIMSourceUser Viewset
sources_scim_users_destroy 1 param → 204400403
GET
/sources/scim_users/{id}/used_by/
Get a list of all objects that use this object
sources_scim_users_used_by_list 1 param → 200400403
GET
/sources/telegram/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_list 15 params → 200400403
POST
/sources/telegram/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_create body → 201400403
GET
/sources/telegram/{slug}/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_retrieve 1 param → 200400403
PUT
/sources/telegram/{slug}/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_update 1 param body → 200400403
PATCH
/sources/telegram/{slug}/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_partial_update 1 param body → 200400403
DELETE
/sources/telegram/{slug}/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_destroy 1 param → 204400403
POST
/sources/telegram/{slug}/connect_user/
Mixin to add a usedby endpoint to return a list of all objects using this object
sources_telegram_connect_user_create 1 param body → 201403400
GET
/sources/telegram/{slug}/used_by/
Get a list of all objects that use this object
sources_telegram_used_by_list 1 param → 200400403
GET
/sources/user_connections/all/
User-source connection Viewset
sources_user_connections_all_list 6 params → 200400403
GET
/sources/user_connections/all/{id}/
User-source connection Viewset
sources_user_connections_all_retrieve 1 param → 200400403
PUT
/sources/user_connections/all/{id}/
User-source connection Viewset
sources_user_connections_all_update 1 param body → 200400403
PATCH
/sources/user_connections/all/{id}/
User-source connection Viewset
sources_user_connections_all_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/all/{id}/
User-source connection Viewset
sources_user_connections_all_destroy 1 param → 204400403
GET
/sources/user_connections/all/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_all_used_by_list 1 param → 200400403
GET
/sources/user_connections/kerberos/
User-source connection Viewset
sources_user_connections_kerberos_list 6 params → 200400403
POST
/sources/user_connections/kerberos/
User-source connection Viewset
sources_user_connections_kerberos_create body → 201400403
GET
/sources/user_connections/kerberos/{id}/
User-source connection Viewset
sources_user_connections_kerberos_retrieve 1 param → 200400403
PUT
/sources/user_connections/kerberos/{id}/
User-source connection Viewset
sources_user_connections_kerberos_update 1 param body → 200400403
PATCH
/sources/user_connections/kerberos/{id}/
User-source connection Viewset
sources_user_connections_kerberos_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/kerberos/{id}/
User-source connection Viewset
sources_user_connections_kerberos_destroy 1 param → 204400403
GET
/sources/user_connections/kerberos/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_kerberos_used_by_list 1 param → 200400403
GET
/sources/user_connections/ldap/
User-source connection Viewset
sources_user_connections_ldap_list 6 params → 200400403
POST
/sources/user_connections/ldap/
User-source connection Viewset
sources_user_connections_ldap_create body → 201400403
GET
/sources/user_connections/ldap/{id}/
User-source connection Viewset
sources_user_connections_ldap_retrieve 1 param → 200400403
PUT
/sources/user_connections/ldap/{id}/
User-source connection Viewset
sources_user_connections_ldap_update 1 param body → 200400403
PATCH
/sources/user_connections/ldap/{id}/
User-source connection Viewset
sources_user_connections_ldap_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/ldap/{id}/
User-source connection Viewset
sources_user_connections_ldap_destroy 1 param → 204400403
GET
/sources/user_connections/ldap/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_ldap_used_by_list 1 param → 200400403
GET
/sources/user_connections/oauth/
User-source connection Viewset
sources_user_connections_oauth_list 6 params → 200400403
POST
/sources/user_connections/oauth/
User-source connection Viewset
sources_user_connections_oauth_create body → 201400403
GET
/sources/user_connections/oauth/{id}/
User-source connection Viewset
sources_user_connections_oauth_retrieve 1 param → 200400403
PUT
/sources/user_connections/oauth/{id}/
User-source connection Viewset
sources_user_connections_oauth_update 1 param body → 200400403
PATCH
/sources/user_connections/oauth/{id}/
User-source connection Viewset
sources_user_connections_oauth_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/oauth/{id}/
User-source connection Viewset
sources_user_connections_oauth_destroy 1 param → 204400403
GET
/sources/user_connections/oauth/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_oauth_used_by_list 1 param → 200400403
GET
/sources/user_connections/plex/
User-source connection Viewset
sources_user_connections_plex_list 6 params → 200400403
POST
/sources/user_connections/plex/
User-source connection Viewset
sources_user_connections_plex_create body → 201400403
GET
/sources/user_connections/plex/{id}/
User-source connection Viewset
sources_user_connections_plex_retrieve 1 param → 200400403
PUT
/sources/user_connections/plex/{id}/
User-source connection Viewset
sources_user_connections_plex_update 1 param body → 200400403
PATCH
/sources/user_connections/plex/{id}/
User-source connection Viewset
sources_user_connections_plex_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/plex/{id}/
User-source connection Viewset
sources_user_connections_plex_destroy 1 param → 204400403
GET
/sources/user_connections/plex/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_plex_used_by_list 1 param → 200400403
GET
/sources/user_connections/saml/
User-source connection Viewset
sources_user_connections_saml_list 6 params → 200400403
POST
/sources/user_connections/saml/
User-source connection Viewset
sources_user_connections_saml_create body → 201400403
GET
/sources/user_connections/saml/{id}/
User-source connection Viewset
sources_user_connections_saml_retrieve 1 param → 200400403
PUT
/sources/user_connections/saml/{id}/
User-source connection Viewset
sources_user_connections_saml_update 1 param body → 200400403
PATCH
/sources/user_connections/saml/{id}/
User-source connection Viewset
sources_user_connections_saml_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/saml/{id}/
User-source connection Viewset
sources_user_connections_saml_destroy 1 param → 204400403
GET
/sources/user_connections/saml/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_saml_used_by_list 1 param → 200400403
GET
/sources/user_connections/telegram/
User-source connection Viewset
sources_user_connections_telegram_list 6 params → 200400403
POST
/sources/user_connections/telegram/
User-source connection Viewset
sources_user_connections_telegram_create body → 201400403
GET
/sources/user_connections/telegram/{id}/
User-source connection Viewset
sources_user_connections_telegram_retrieve 1 param → 200400403
PUT
/sources/user_connections/telegram/{id}/
User-source connection Viewset
sources_user_connections_telegram_update 1 param body → 200400403
PATCH
/sources/user_connections/telegram/{id}/
User-source connection Viewset
sources_user_connections_telegram_partial_update 1 param body → 200400403
DELETE
/sources/user_connections/telegram/{id}/
User-source connection Viewset
sources_user_connections_telegram_destroy 1 param → 204400403
GET
/sources/user_connections/telegram/{id}/used_by/
Get a list of all objects that use this object
sources_user_connections_telegram_used_by_list 1 param → 200400403

Schemas 135

The contract defines 135 schemas that model the data the API accepts and returns. The most detailed are LDAPSource (44 properties), SAMLSource (38 properties), LDAPSourceRequest (36 properties), PatchedLDAPSourceRequest (36 properties). Each schema is shown below with its type and property counts.

PaginatedUserSAMLSourceConnectionList
object
3 properties 3 required
PaginatedUserKerberosSourceConnectionList
object
3 properties 3 required
Role
object
Role serializer
2 properties 2 required
Token
object
Token Serializer
9 properties 3 required
PaginatedSCIMSourceGroupList
object
3 properties 3 required
GroupKerberosSourceConnection
object
Group Source Connection
7 properties 7 required
UserSetting
object
Serializer for User settings for stages and sources
5 properties 3 required
AuthorizationCodeAuthMethodEnum
string
PatchedGroupLDAPSourceConnectionRequest
object
Group Source Connection
2 properties
GroupSAMLSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
ThemedUrls
object
Themed URLs - maps theme names to URLs for light and dark themes
2 properties
User
object
User Serializer
20 properties 12 required
DigestAlgorithmEnum
string
PlexTokenRedeemRequest
object
Serializer to redeem a plex token
1 property 1 required
PaginatedGroupKerberosSourceConnectionList
object
3 properties 3 required
TelegramSource
object
Source Serializer
23 properties 12 required
PaginatedLDAPSourceList
object
3 properties 3 required
PatchedUserOAuthSourceConnectionRequest
object
User source connection
4 properties
Autocomplete
object
UserSAMLSourceConnectionRequest
object
User source connection
2 properties 2 required
GroupSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
PatchedSCIMSourceGroupRequest
object
SCIMSourceGroup Serializer
5 properties
LDAPSource
object
LDAP Source Serializer
44 properties 13 required
UserOAuthSourceConnection
object
User source connection
8 properties 7 required
GroupMatchingModeEnum
string
PaginatedGroupSAMLSourceConnectionList
object
3 properties 3 required
SourceType
object
Serializer for SourceType
9 properties 9 required
PaginatedSAMLSourceList
object
3 properties 3 required
LDAPSourceRequest
object
LDAP Source Serializer
36 properties 4 required
GroupPlexSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
BindingTypeEnum
string
Source
object
Source Serializer
20 properties 10 required
PatchedSCIMSourceUserRequest
object
SCIMSourceUser Serializer
5 properties
GroupSourceConnection
object
Group Source Connection
7 properties 7 required
UserOAuthSourceConnectionRequest
object
User source connection
4 properties 2 required
ErrorDetail
object
Serializer for restframework's error messages
2 properties 2 required
PatchedTelegramSourceRequest
object
Source Serializer
16 properties
SCIMSourceRequest
object
SCIMSource Serializer
6 properties 2 required
PatchedGroupPlexSourceConnectionRequest
object
Group Source Connection
2 properties
SCIMSourceUserRequest
object
SCIMSourceUser Serializer
5 properties 3 required
PatchedSCIMSourceRequest
object
SCIMSource Serializer
6 properties
PaginatedSourceList
object
3 properties 3 required
OAuthSource
object
OAuth Source Serializer
35 properties 14 required
ContextualFlowInfo
object
Contextual flow information for a challenge
6 properties 2 required
Pagination
object
7 properties 7 required
KerberosSourceRequest
object
Kerberos Source Serializer
27 properties 3 required
SCIMSourceGroup
object
SCIMSourceGroup Serializer
6 properties 4 required
RedirectChallenge
object
Challenge type to redirect the client
5 properties 1 required
UserTypeEnum
string
PaginatedUserOAuthSourceConnectionList
object
3 properties 3 required
OAuthSourceRequest
object
OAuth Source Serializer
26 properties 5 required
SignatureAlgorithmEnum
string
SCIMSourceUser
object
SCIMSourceUser Serializer
6 properties 4 required
PatchedLDAPSourceRequest
object
LDAP Source Serializer
36 properties
PaginatedGroupSourceConnectionList
object
3 properties 3 required
TypeCreate
object
Types of an object that can be created
7 properties 4 required
ContextualFlowInfoLayoutEnum
string
PaginatedKerberosSourceList
object
3 properties 3 required
PolicyEngineMode
string
UserTelegramSourceConnection
object
User source connection
7 properties 7 required
PartialUser
object
Partial User Serializer, does not include child relations.
8 properties 4 required
GroupSAMLSourceConnection
object
Group Source Connection
7 properties 7 required
KerberosSource
object
Kerberos Source Serializer
33 properties 12 required
UserSourceConnection
object
User source connection
7 properties 7 required
SyncOutgoingTriggerModeEnum
string
SCIMSource
object
SCIMSource Serializer
14 properties 10 required
PartialGroup
object
Partial Group Serializer, does not include child relations.
5 properties 3 required
PatchedGroupKerberosSourceConnectionRequest
object
Group Source Connection
2 properties
PatchedOAuthSourceRequest
object
OAuth Source Serializer
26 properties
SAMLMetadata
object
SAML Provider Metadata serializer
2 properties 1 required
PatchedGroupSourceConnectionRequest
object
Group Source Connection
2 properties
LDAPDebug
object
3 properties 3 required
ProviderTypeEnum
string
GroupKerberosSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
PaginatedSCIMSourceList
object
3 properties 3 required
PatchedUserLDAPSourceConnectionRequest
object
User source connection
2 properties
PatchedGroupTelegramSourceConnectionRequest
object
Group Source Connection
2 properties
PlexSourceRequest
object
Plex Source Serializer
17 properties 3 required
UsedByActionEnum
string
FlowMessage
object
Serializer for a django.contrib.messages message
2 properties 2 required
PatchedKerberosSourceRequest
object
Kerberos Source Serializer
27 properties
PatchedPlexSourceRequest
object
Plex Source Serializer
17 properties
PaginatedGroupLDAPSourceConnectionList
object
3 properties 3 required
PatchedUserSourceConnectionRequest
object
User source connection
2 properties
UserLDAPSourceConnectionRequest
object
User source connection
2 properties 2 required
UserTelegramSourceConnectionRequest
object
User source connection
2 properties 2 required
PatchedGroupOAuthSourceConnectionRequest
object
Group Source Connection
2 properties
TaskAggregatedStatusEnum
string
GroupLDAPSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
GroupLDAPSourceConnection
object
Group Source Connection
8 properties 8 required
PaginatedTelegramSourceList
object
3 properties 3 required
UserSourceConnectionRequest
object
User source connection
2 properties 2 required
FlowMessageLevelEnum
string
PaginatedUserTelegramSourceConnectionList
object
3 properties 3 required
PatchedGroupSAMLSourceConnectionRequest
object
Group Source Connection
2 properties
PatchedSAMLSourceRequest
object
SAMLSource Serializer
29 properties
SAMLSourceRequest
object
SAMLSource Serializer
29 properties 4 required
UserPlexSourceConnectionRequest
object
User source connection
3 properties 3 required
PlexSource
object
Plex Source Serializer
25 properties 11 required
GroupPlexSourceConnection
object
Group Source Connection
7 properties 7 required
GroupOAuthSourceConnection
object
Group Source Connection
7 properties 7 required
PatchedUserSAMLSourceConnectionRequest
object
User source connection
2 properties
KadminTypeEnum
string
UsedBy
object
A list of all objects referencing the queried object
5 properties 5 required
GroupOAuthSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
SyncStatus
object
Provider/source sync status
3 properties 1 required
PaginatedPlexSourceList
object
3 properties 3 required
PaginatedUserSourceConnectionList
object
3 properties 3 required
PKCEMethodEnum
string
PaginatedOAuthSourceList
object
3 properties 3 required
UserKerberosSourceConnectionRequest
object
User source connection
2 properties 2 required
IntentEnum
string
SAMLNameIDPolicyEnum
string
UserLDAPSourceConnection
object
User source connection
8 properties 8 required
ValidationError
object
Validation Error
2 properties
UserPlexSourceConnection
object
User source connection
7 properties 7 required
PatchedUserTelegramSourceConnectionRequest
object
User source connection
2 properties
TelegramAuthRequest
object
7 properties 3 required
PaginatedSCIMSourceUserList
object
3 properties 3 required
UserMatchingModeEnum
string
PaginatedUserLDAPSourceConnectionList
object
3 properties 3 required
GroupTelegramSourceConnectionRequest
object
Group Source Connection
2 properties 2 required
TelegramSourceRequest
object
Source Serializer
16 properties 5 required
SCIMSourceGroupRequest
object
SCIMSourceGroup Serializer
5 properties 3 required
UserKerberosSourceConnection
object
User source connection
7 properties 7 required
UserSAMLSourceConnection
object
User source connection
7 properties 7 required
SAMLSource
object
SAMLSource Serializer
38 properties 13 required
PaginatedGroupPlexSourceConnectionList
object
3 properties 3 required
PatchedUserKerberosSourceConnectionRequest
object
User source connection
2 properties
PaginatedUserPlexSourceConnectionList
object
3 properties 3 required
PaginatedGroupTelegramSourceConnectionList
object
3 properties 3 required
PatchedUserPlexSourceConnectionRequest
object
User source connection
3 properties
PaginatedGroupOAuthSourceConnectionList
object
3 properties 3 required
GenericError
object
Generic API Error
2 properties 1 required
GroupTelegramSourceConnection
object
Group Source Connection
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

authentik-sources-api-openapi.yml Raw ↑

Other APIs Authentik publishes across the network.

Authentik Core API
Authentik Crypto API
Authentik Events API
Authentik Flows API
Authentik Policies API
Authentik Providers API
Authentik RBAC API
Authentik Schema API
Authentik Stages API
Authentik Admin API
Authentik Agents API
Authentik Authenticators API
Where this information came from

This is an independent, third-party profile of Authentik Sources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.