The identity and technical contract details declared by the specification.
Stage
object
Stage Serializer
7 properties
7 required
PatchedAuthenticatorValidateStageRequest
object
AuthenticatorValidateStage Serializer
12 properties
DenyStageRequest
object
DenyStage Serializer
2 properties
1 required
PatchedRedirectStageRequest
object
RedirectStage Serializer
5 properties
MutualTLSStageRequest
object
MutualTLSStage Serializer
5 properties
4 required
UserSetting
object
Serializer for User settings for stages and sources
5 properties
3 required
AccountLockdownStage
object
AccountLockdownStage Serializer
12 properties
7 required
MutualTLSStage
object
MutualTLSStage Serializer
11 properties
10 required
ConsentStageRequest
object
ConsentStage Serializer
3 properties
1 required
UserDeleteStage
object
UserDeleteStage Serializer
7 properties
7 required
IdentificationStage
object
IdentificationStage Serializer
20 properties
7 required
ThemedUrls
object
Themed URLs - maps theme names to URLs for light and dark themes
2 properties
PaginatedCaptchaStageList
object
3 properties
3 required
AuthenticatorEndpointGDTCStage
object
AuthenticatorEndpointGDTCStage Serializer
10 properties
8 required
EndpointStageRequest
object
EndpointStage Serializer
3 properties
2 required
AuthenticatorStaticStage
object
AuthenticatorStaticStage Serializer
11 properties
7 required
PromptChoice
object
Serializer for a single Choice field
2 properties
2 required
UserCreationModeEnum
string
DuoDeviceEnrollmentStatus
object
1 property
1 required
PatchedMutualTLSStageRequest
object
MutualTLSStage Serializer
5 properties
PaginatedConsentStageList
object
3 properties
3 required
PaginatedPasswordStageList
object
3 properties
3 required
PaginatedInvitationList
object
3 properties
3 required
IdentificationStageRequest
object
IdentificationStage Serializer
14 properties
1 required
PaginatedAuthenticatorEndpointGDTCStageList
object
3 properties
3 required
AuthenticatorWebAuthnStage
object
AuthenticatorWebAuthnStage Serializer
16 properties
8 required
AuthenticatorAttachmentEnum
string
NetworkBindingEnum
string
PaginatedPromptList
object
3 properties
3 required
UserVerificationEnum
string
PatchedAuthenticatorDuoStageRequest
object
AuthenticatorDuoStage Serializer
8 properties
UserLogoutStageRequest
object
UserLogoutStage Serializer
1 property
1 required
PaginatedRedirectStageList
object
3 properties
3 required
PatchedSourceStageRequest
object
SourceStage Serializer
4 properties
ErrorDetail
object
Serializer for restframework's error messages
2 properties
2 required
PaginatedMutualTLSStageList
object
3 properties
3 required
EmailStage
object
EmailStage Serializer
21 properties
7 required
PaginatedDenyStageList
object
3 properties
3 required
WebAuthnDeviceType
object
WebAuthnDeviceType Serializer
2 properties
2 required
PaginatedInvitationStageList
object
3 properties
3 required
UserLoginStage
object
UserLoginStage Serializer
13 properties
7 required
ContextualFlowInfo
object
Contextual flow information for a challenge
6 properties
2 required
PatchedUserLogoutStageRequest
object
UserLogoutStage Serializer
1 property
Pagination
object
7 properties
7 required
PaginatedAuthenticatorEmailStageList
object
3 properties
3 required
PatchedConsentStageRequest
object
ConsentStage Serializer
3 properties
PromptStage
object
PromptStage Serializer
9 properties
8 required
PromptRequest
object
Prompt Serializer
11 properties
4 required
PatchedInvitationStageRequest
object
InvitationStage Serializer
2 properties
RequestContentTypeEnum
string
NotConfiguredActionEnum
string
AuthenticatorTOTPStageRequest
object
AuthenticatorTOTPStage Serializer
4 properties
2 required
AuthenticatorDuoStageDeviceImportResponse
object
2 properties
2 required
SourceStageRequest
object
SourceStage Serializer
4 properties
2 required
RedirectStageModeEnum
string
AuthenticatorSMSStageRequest
object
AuthenticatorSMSStage Serializer
11 properties
5 required
PatchedAccountLockdownStageRequest
object
AccountLockdownStage Serializer
6 properties
EndpointStage
object
EndpointStage Serializer
10 properties
9 required
TypeCreate
object
Types of an object that can be created
7 properties
4 required
ContextualFlowInfoLayoutEnum
string
UserLogoutStage
object
UserLogoutStage Serializer
7 properties
7 required
PromptStageRequest
object
PromptStage Serializer
3 properties
2 required
PaginatedIdentificationStageList
object
3 properties
3 required
PatchedAuthenticatorEndpointGDTCStageRequest
object
AuthenticatorEndpointGDTCStage Serializer
4 properties
StagePrompt
object
Serializer for a single Prompt field
9 properties
9 required
PaginatedUserDeleteStageList
object
3 properties
3 required
PartialUser
object
Partial User Serializer, does not include child relations.
8 properties
4 required
PaginatedDummyStageList
object
3 properties
3 required
PaginatedAuthenticatorTOTPStageList
object
3 properties
3 required
PaginatedAuthenticatorSMSStageList
object
3 properties
3 required
UserDeleteStageRequest
object
UserDeleteStage Serializer
1 property
1 required
PatchedUserLoginStageRequest
object
UserLoginStage Serializer
7 properties
UserLoginStageRequest
object
UserLoginStage Serializer
7 properties
1 required
AuthenticatorDuoStageRequest
object
AuthenticatorDuoStage Serializer
8 properties
4 required
PaginatedUserLogoutStageList
object
3 properties
3 required
SourceStage
object
SourceStage Serializer
10 properties
8 required
AuthenticatorEmailStage
object
AuthenticatorEmailStage Serializer
21 properties
7 required
AuthenticatorWebAuthnStageRequest
object
AuthenticatorWebAuthnStage Serializer
9 properties
1 required
InvitationRequest
object
Invitation Serializer
5 properties
1 required
PatchedDenyStageRequest
object
DenyStage Serializer
2 properties
PatchedUserDeleteStageRequest
object
UserDeleteStage Serializer
1 property
PaginatedAuthenticatorWebAuthnStageList
object
3 properties
3 required
AccountLockdownStageRequest
object
AccountLockdownStage Serializer
6 properties
1 required
RedirectStageRequest
object
RedirectStage Serializer
5 properties
2 required
PatchedEmailStageRequest
object
EmailStage Serializer
16 properties
PaginatedStageList
object
3 properties
3 required
DummyStageRequest
object
DummyStage Serializer
2 properties
1 required
PaginatedEndpointStageList
object
3 properties
3 required
Invitation
object
Invitation Serializer
8 properties
4 required
PromptChallenge
object
Initial challenge being sent, define fields
4 properties
1 required
AuthenticationEnum
string
FlowMessage
object
Serializer for a django.contrib.messages message
2 properties
2 required
AuthenticatorTOTPStage
object
AuthenticatorTOTPStage Serializer
10 properties
8 required
FlowSet
object
Stripped down flow serializer
12 properties
8 required
PaginatedAuthenticatorValidateStageList
object
3 properties
3 required
AuthenticatorEndpointGDTCStageRequest
object
AuthenticatorEndpointGDTCStage Serializer
4 properties
2 required
Flow
object
Flow Serializer
18 properties
12 required
PatchedAuthenticatorStaticStageRequest
object
AuthenticatorStaticStage Serializer
5 properties
AuthenticatorDuoStageManualDeviceImportRequest
object
2 properties
2 required
PatchedUserWriteStageRequest
object
UserWriteStage Serializer
6 properties
UserWriteStageRequest
object
UserWriteStage Serializer
6 properties
1 required
PatchedPromptRequest
object
Prompt Serializer
11 properties
ConsentStage
object
ConsentStage Serializer
9 properties
7 required
DenyStage
object
DenyStage Serializer
8 properties
7 required
FlowMessageLevelEnum
string
PatchedPasswordStageRequest
object
PasswordStage Serializer
5 properties
PatchedAuthenticatorWebAuthnStageRequest
object
AuthenticatorWebAuthnStage Serializer
9 properties
AuthenticatorValidateStage
object
AuthenticatorValidateStage Serializer
19 properties
8 required
UserWriteStage
object
UserWriteStage Serializer
12 properties
7 required
AuthenticatorDuoStage
object
AuthenticatorDuoStage Serializer
12 properties
9 required
PaginatedWebAuthnDeviceTypeList
object
3 properties
3 required
UsedBy
object
A list of all objects referencing the queried object
5 properties
5 required
PaginatedUserLoginStageList
object
3 properties
3 required
CaptchaStageRequest
object
CaptchaStage Serializer
10 properties
3 required
PaginatedAccountLockdownStageList
object
3 properties
3 required
PaginatedAuthenticatorDuoStageList
object
3 properties
3 required
PaginatedPromptStageList
object
3 properties
3 required
PatchedEndpointStageRequest
object
EndpointStage Serializer
3 properties
Connector
object
7 properties
5 required
FlowDesignationEnum
string
InvitationSendEmailRequest
object
Serializer for sending invitation emails
4 properties
1 required
PatchedInvitationRequest
object
Invitation Serializer
5 properties
PatchedAuthenticatorTOTPStageRequest
object
AuthenticatorTOTPStage Serializer
4 properties
PatchedPromptStageRequest
object
PromptStage Serializer
3 properties
ResumeOnMatchFailuresEnum
string
ValidationError
object
Validation Error
2 properties
PasswordStageRequest
object
PasswordStage Serializer
5 properties
2 required
Prompt
object
Prompt Serializer
13 properties
6 required
RedirectStage
object
RedirectStage Serializer
11 properties
8 required
PatchedAuthenticatorEmailStageRequest
object
AuthenticatorEmailStage Serializer
15 properties
PaginatedEmailStageList
object
3 properties
3 required
PatchedIdentificationStageRequest
object
IdentificationStage Serializer
14 properties
CaptchaStage
object
CaptchaStage Serializer
15 properties
8 required
PaginatedAuthenticatorStaticStageList
object
3 properties
3 required
AuthenticatorValidateStageRequest
object
AuthenticatorValidateStage Serializer
12 properties
1 required
PaginatedUserWriteStageList
object
3 properties
3 required
PaginatedSourceStageList
object
3 properties
3 required
InvitationStageRequest
object
InvitationStage Serializer
2 properties
1 required
AuthenticatorStaticStageRequest
object
AuthenticatorStaticStage Serializer
5 properties
1 required
GenericError
object
Generic API Error
2 properties
1 required
DummyStage
object
DummyStage Serializer
8 properties
7 required
PasswordStage
object
PasswordStage Serializer
11 properties
8 required
PatchedCaptchaStageRequest
object
CaptchaStage Serializer
10 properties
AuthenticatorEmailStageRequest
object
AuthenticatorEmailStage Serializer
15 properties
1 required
EmailStageRequest
object
EmailStage Serializer
16 properties
1 required
InvitationStage
object
InvitationStage Serializer
8 properties
7 required
PatchedDummyStageRequest
object
DummyStage Serializer
2 properties
AuthenticatorSMSStage
object
AuthenticatorSMSStage Serializer
17 properties
11 required
PatchedAuthenticatorSMSStageRequest
object
AuthenticatorSMSStage Serializer
11 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Authentik publishes across the network.