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.
The identity and technical contract details declared by the specification.
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
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
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
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
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
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
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
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
PaginatedOAuthSourceList
object
3 properties
3 required
UserKerberosSourceConnectionRequest
object
User source connection
2 properties
2 required
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Authentik publishes across the network.