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 Stages API

Flow stages: identification, password, consent, prompt, email, captcha, mTLS, redirect, user write/login/logout/delete, account lockdown and every authenticator setup and validation stage.

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

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

This API exposes 210 operations across 97 paths, and defines 169 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.

210 operations 97 paths 169 schemas 29 DELETE92 GET28 PATCH33 POST28 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 Stages 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 210

Across 97 paths, the API surfaces 210 operations — 29 DELETE, 92 GET, 28 PATCH, 33 POST, 28 PUT. Each is listed below with its method, path, parameters, and response codes.

stages 210
GET
/stages/account_lockdown/
AccountLockdownStage Viewset
stages_account_lockdown_list 11 params → 200400403
POST
/stages/account_lockdown/
AccountLockdownStage Viewset
stages_account_lockdown_create body → 201400403
GET
/stages/account_lockdown/{stage_uuid}/
AccountLockdownStage Viewset
stages_account_lockdown_retrieve 1 param → 200400403
PUT
/stages/account_lockdown/{stage_uuid}/
AccountLockdownStage Viewset
stages_account_lockdown_update 1 param body → 200400403
PATCH
/stages/account_lockdown/{stage_uuid}/
AccountLockdownStage Viewset
stages_account_lockdown_partial_update 1 param body → 200400403
DELETE
/stages/account_lockdown/{stage_uuid}/
AccountLockdownStage Viewset
stages_account_lockdown_destroy 1 param → 204400403
GET
/stages/account_lockdown/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_account_lockdown_used_by_list 1 param → 200400403
GET
/stages/all/
Stage Viewset
stages_all_list 5 params → 200400403
GET
/stages/all/{stage_uuid}/
Stage Viewset
stages_all_retrieve 1 param → 200400403
DELETE
/stages/all/{stage_uuid}/
Stage Viewset
stages_all_destroy 1 param → 204400403
GET
/stages/all/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_all_used_by_list 1 param → 200400403
GET
/stages/all/types/
Get all creatable types
stages_all_types_list → 200400403
GET
/stages/all/user_settings/
Get all stages the user can configure
stages_all_user_settings_list → 200400403
GET
/stages/authenticator/duo/
AuthenticatorDuoStage Viewset
stages_authenticator_duo_list 8 params → 200400403
POST
/stages/authenticator/duo/
AuthenticatorDuoStage Viewset
stages_authenticator_duo_create body → 201400403
GET
/stages/authenticator/duo/{stage_uuid}/
AuthenticatorDuoStage Viewset
stages_authenticator_duo_retrieve 1 param → 200400403
PUT
/stages/authenticator/duo/{stage_uuid}/
AuthenticatorDuoStage Viewset
stages_authenticator_duo_update 1 param body → 200400403
PATCH
/stages/authenticator/duo/{stage_uuid}/
AuthenticatorDuoStage Viewset
stages_authenticator_duo_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/duo/{stage_uuid}/
AuthenticatorDuoStage Viewset
stages_authenticator_duo_destroy 1 param → 204400403
POST
/stages/authenticator/duo/{stage_uuid}/enrollment_status/
Check enrollment status of user details in current session
stages_authenticator_duo_enrollment_status_create 1 param → 200400403
POST
/stages/authenticator/duo/{stage_uuid}/import_device_manual/
Import duo devices into authentik
stages_authenticator_duo_import_device_manual_create 1 param body → 204400403
POST
/stages/authenticator/duo/{stage_uuid}/import_devices_automatic/
Import duo devices into authentik
stages_authenticator_duo_import_devices_automatic_create 1 param → 200400403
GET
/stages/authenticator/duo/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_duo_used_by_list 1 param → 200400403
GET
/stages/authenticator/email/
AuthenticatorEmailStage Viewset
stages_authenticator_email_list 20 params → 200400403
POST
/stages/authenticator/email/
AuthenticatorEmailStage Viewset
stages_authenticator_email_create body → 201400403
GET
/stages/authenticator/email/{stage_uuid}/
AuthenticatorEmailStage Viewset
stages_authenticator_email_retrieve 1 param → 200400403
PUT
/stages/authenticator/email/{stage_uuid}/
AuthenticatorEmailStage Viewset
stages_authenticator_email_update 1 param body → 200400403
PATCH
/stages/authenticator/email/{stage_uuid}/
AuthenticatorEmailStage Viewset
stages_authenticator_email_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/email/{stage_uuid}/
AuthenticatorEmailStage Viewset
stages_authenticator_email_destroy 1 param → 204400403
GET
/stages/authenticator/email/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_email_used_by_list 1 param → 200400403
GET
/stages/authenticator/endpoint_gdtc/
AuthenticatorEndpointGDTCStage Viewset
stages_authenticator_endpoint_gdtc_list 6 params → 200400403
POST
/stages/authenticator/endpoint_gdtc/
AuthenticatorEndpointGDTCStage Viewset
stages_authenticator_endpoint_gdtc_create body → 201400403
GET
/stages/authenticator/endpoint_gdtc/{stage_uuid}/
AuthenticatorEndpointGDTCStage Viewset
stages_authenticator_endpoint_gdtc_retrieve 1 param → 200400403
PUT
/stages/authenticator/endpoint_gdtc/{stage_uuid}/
AuthenticatorEndpointGDTCStage Viewset
stages_authenticator_endpoint_gdtc_update 1 param body → 200400403
PATCH
/stages/authenticator/endpoint_gdtc/{stage_uuid}/
AuthenticatorEndpointGDTCStage Viewset
stages_authenticator_endpoint_gdtc_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/endpoint_gdtc/{stage_uuid}/
AuthenticatorEndpointGDTCStage Viewset
stages_authenticator_endpoint_gdtc_destroy 1 param → 204400403
GET
/stages/authenticator/endpoint_gdtc/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_endpoint_gdtc_used_by_list 1 param → 200400403
GET
/stages/authenticator/sms/
AuthenticatorSMSStage Viewset
stages_authenticator_sms_list 16 params → 200400403
POST
/stages/authenticator/sms/
AuthenticatorSMSStage Viewset
stages_authenticator_sms_create body → 201400403
GET
/stages/authenticator/sms/{stage_uuid}/
AuthenticatorSMSStage Viewset
stages_authenticator_sms_retrieve 1 param → 200400403
PUT
/stages/authenticator/sms/{stage_uuid}/
AuthenticatorSMSStage Viewset
stages_authenticator_sms_update 1 param body → 200400403
PATCH
/stages/authenticator/sms/{stage_uuid}/
AuthenticatorSMSStage Viewset
stages_authenticator_sms_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/sms/{stage_uuid}/
AuthenticatorSMSStage Viewset
stages_authenticator_sms_destroy 1 param → 204400403
GET
/stages/authenticator/sms/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_sms_used_by_list 1 param → 200400403
GET
/stages/authenticator/static/
AuthenticatorStaticStage Viewset
stages_authenticator_static_list 10 params → 200400403
POST
/stages/authenticator/static/
AuthenticatorStaticStage Viewset
stages_authenticator_static_create body → 201400403
GET
/stages/authenticator/static/{stage_uuid}/
AuthenticatorStaticStage Viewset
stages_authenticator_static_retrieve 1 param → 200400403
PUT
/stages/authenticator/static/{stage_uuid}/
AuthenticatorStaticStage Viewset
stages_authenticator_static_update 1 param body → 200400403
PATCH
/stages/authenticator/static/{stage_uuid}/
AuthenticatorStaticStage Viewset
stages_authenticator_static_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/static/{stage_uuid}/
AuthenticatorStaticStage Viewset
stages_authenticator_static_destroy 1 param → 204400403
GET
/stages/authenticator/static/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_static_used_by_list 1 param → 200400403
GET
/stages/authenticator/totp/
AuthenticatorTOTPStage Viewset
stages_authenticator_totp_list 9 params → 200400403
POST
/stages/authenticator/totp/
AuthenticatorTOTPStage Viewset
stages_authenticator_totp_create body → 201400403
GET
/stages/authenticator/totp/{stage_uuid}/
AuthenticatorTOTPStage Viewset
stages_authenticator_totp_retrieve 1 param → 200400403
PUT
/stages/authenticator/totp/{stage_uuid}/
AuthenticatorTOTPStage Viewset
stages_authenticator_totp_update 1 param body → 200400403
PATCH
/stages/authenticator/totp/{stage_uuid}/
AuthenticatorTOTPStage Viewset
stages_authenticator_totp_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/totp/{stage_uuid}/
AuthenticatorTOTPStage Viewset
stages_authenticator_totp_destroy 1 param → 204400403
GET
/stages/authenticator/totp/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_totp_used_by_list 1 param → 200400403
GET
/stages/authenticator/validate/
AuthenticatorValidateStage Viewset
stages_authenticator_validate_list 7 params → 200400403
POST
/stages/authenticator/validate/
AuthenticatorValidateStage Viewset
stages_authenticator_validate_create body → 201400403
GET
/stages/authenticator/validate/{stage_uuid}/
AuthenticatorValidateStage Viewset
stages_authenticator_validate_retrieve 1 param → 200400403
PUT
/stages/authenticator/validate/{stage_uuid}/
AuthenticatorValidateStage Viewset
stages_authenticator_validate_update 1 param body → 200400403
PATCH
/stages/authenticator/validate/{stage_uuid}/
AuthenticatorValidateStage Viewset
stages_authenticator_validate_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/validate/{stage_uuid}/
AuthenticatorValidateStage Viewset
stages_authenticator_validate_destroy 1 param → 204400403
GET
/stages/authenticator/validate/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_validate_used_by_list 1 param → 200400403
GET
/stages/authenticator/webauthn/
AuthenticatorWebAuthnStage Viewset
stages_authenticator_webauthn_list 11 params → 200400403
POST
/stages/authenticator/webauthn/
AuthenticatorWebAuthnStage Viewset
stages_authenticator_webauthn_create body → 201400403
GET
/stages/authenticator/webauthn/{stage_uuid}/
AuthenticatorWebAuthnStage Viewset
stages_authenticator_webauthn_retrieve 1 param → 200400403
PUT
/stages/authenticator/webauthn/{stage_uuid}/
AuthenticatorWebAuthnStage Viewset
stages_authenticator_webauthn_update 1 param body → 200400403
PATCH
/stages/authenticator/webauthn/{stage_uuid}/
AuthenticatorWebAuthnStage Viewset
stages_authenticator_webauthn_partial_update 1 param body → 200400403
DELETE
/stages/authenticator/webauthn/{stage_uuid}/
AuthenticatorWebAuthnStage Viewset
stages_authenticator_webauthn_destroy 1 param → 204400403
GET
/stages/authenticator/webauthn/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_authenticator_webauthn_used_by_list 1 param → 200400403
GET
/stages/authenticator/webauthn_device_types/
WebAuthnDeviceType Viewset
stages_authenticator_webauthn_device_types_list 7 params → 200400403
GET
/stages/authenticator/webauthn_device_types/{aaguid}/
WebAuthnDeviceType Viewset
stages_authenticator_webauthn_device_types_retrieve 1 param → 200400403
GET
/stages/captcha/
CaptchaStage Viewset
stages_captcha_list 6 params → 200400403
POST
/stages/captcha/
CaptchaStage Viewset
stages_captcha_create body → 201400403
GET
/stages/captcha/{stage_uuid}/
CaptchaStage Viewset
stages_captcha_retrieve 1 param → 200400403
PUT
/stages/captcha/{stage_uuid}/
CaptchaStage Viewset
stages_captcha_update 1 param body → 200400403
PATCH
/stages/captcha/{stage_uuid}/
CaptchaStage Viewset
stages_captcha_partial_update 1 param body → 200400403
DELETE
/stages/captcha/{stage_uuid}/
CaptchaStage Viewset
stages_captcha_destroy 1 param → 204400403
GET
/stages/captcha/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_captcha_used_by_list 1 param → 200400403
GET
/stages/consent/
ConsentStage Viewset
stages_consent_list 8 params → 200400403
POST
/stages/consent/
ConsentStage Viewset
stages_consent_create body → 201400403
GET
/stages/consent/{stage_uuid}/
ConsentStage Viewset
stages_consent_retrieve 1 param → 200400403
PUT
/stages/consent/{stage_uuid}/
ConsentStage Viewset
stages_consent_update 1 param body → 200400403
PATCH
/stages/consent/{stage_uuid}/
ConsentStage Viewset
stages_consent_partial_update 1 param body → 200400403
DELETE
/stages/consent/{stage_uuid}/
ConsentStage Viewset
stages_consent_destroy 1 param → 204400403
GET
/stages/consent/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_consent_used_by_list 1 param → 200400403
GET
/stages/deny/
DenyStage Viewset
stages_deny_list 7 params → 200400403
POST
/stages/deny/
DenyStage Viewset
stages_deny_create body → 201400403
GET
/stages/deny/{stage_uuid}/
DenyStage Viewset
stages_deny_retrieve 1 param → 200400403
PUT
/stages/deny/{stage_uuid}/
DenyStage Viewset
stages_deny_update 1 param body → 200400403
PATCH
/stages/deny/{stage_uuid}/
DenyStage Viewset
stages_deny_partial_update 1 param body → 200400403
DELETE
/stages/deny/{stage_uuid}/
DenyStage Viewset
stages_deny_destroy 1 param → 204400403
GET
/stages/deny/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_deny_used_by_list 1 param → 200400403
GET
/stages/dummy/
DummyStage Viewset
stages_dummy_list 7 params → 200400403
POST
/stages/dummy/
DummyStage Viewset
stages_dummy_create body → 201400403
GET
/stages/dummy/{stage_uuid}/
DummyStage Viewset
stages_dummy_retrieve 1 param → 200400403
PUT
/stages/dummy/{stage_uuid}/
DummyStage Viewset
stages_dummy_update 1 param body → 200400403
PATCH
/stages/dummy/{stage_uuid}/
DummyStage Viewset
stages_dummy_partial_update 1 param body → 200400403
DELETE
/stages/dummy/{stage_uuid}/
DummyStage Viewset
stages_dummy_destroy 1 param → 204400403
GET
/stages/dummy/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_dummy_used_by_list 1 param → 200400403
GET
/stages/email/
EmailStage Viewset
stages_email_list 17 params → 200400403
POST
/stages/email/
EmailStage Viewset
stages_email_create body → 201400403
GET
/stages/email/{stage_uuid}/
EmailStage Viewset
stages_email_retrieve 1 param → 200400403
PUT
/stages/email/{stage_uuid}/
EmailStage Viewset
stages_email_update 1 param body → 200400403
PATCH
/stages/email/{stage_uuid}/
EmailStage Viewset
stages_email_partial_update 1 param body → 200400403
DELETE
/stages/email/{stage_uuid}/
EmailStage Viewset
stages_email_destroy 1 param → 204400403
GET
/stages/email/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_email_used_by_list 1 param → 200400403
GET
/stages/email/templates/
Get all available templates, including custom templates
stages_email_templates_list → 200400403
GET
/stages/endpoints/
EndpointStage Viewset
stages_endpoints_list 5 params → 200400403
POST
/stages/endpoints/
EndpointStage Viewset
stages_endpoints_create body → 201400403
GET
/stages/endpoints/{stage_uuid}/
EndpointStage Viewset
stages_endpoints_retrieve 1 param → 200400403
PUT
/stages/endpoints/{stage_uuid}/
EndpointStage Viewset
stages_endpoints_update 1 param body → 200400403
PATCH
/stages/endpoints/{stage_uuid}/
EndpointStage Viewset
stages_endpoints_partial_update 1 param body → 200400403
DELETE
/stages/endpoints/{stage_uuid}/
EndpointStage Viewset
stages_endpoints_destroy 1 param → 204400403
GET
/stages/endpoints/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_endpoints_used_by_list 1 param → 200400403
GET
/stages/identification/
IdentificationStage Viewset
stages_identification_list 14 params → 200400403
POST
/stages/identification/
IdentificationStage Viewset
stages_identification_create body → 201400403
GET
/stages/identification/{stage_uuid}/
IdentificationStage Viewset
stages_identification_retrieve 1 param → 200400403
PUT
/stages/identification/{stage_uuid}/
IdentificationStage Viewset
stages_identification_update 1 param body → 200400403
PATCH
/stages/identification/{stage_uuid}/
IdentificationStage Viewset
stages_identification_partial_update 1 param body → 200400403
DELETE
/stages/identification/{stage_uuid}/
IdentificationStage Viewset
stages_identification_destroy 1 param → 204400403
GET
/stages/identification/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_identification_used_by_list 1 param → 200400403
GET
/stages/invitation/invitations/
Invitation Viewset
stages_invitation_invitations_list 8 params → 200400403
POST
/stages/invitation/invitations/
Invitation Viewset
stages_invitation_invitations_create body → 201400403
GET
/stages/invitation/invitations/{invite_uuid}/
Invitation Viewset
stages_invitation_invitations_retrieve 1 param → 200400403
PUT
/stages/invitation/invitations/{invite_uuid}/
Invitation Viewset
stages_invitation_invitations_update 1 param body → 200400403
PATCH
/stages/invitation/invitations/{invite_uuid}/
Invitation Viewset
stages_invitation_invitations_partial_update 1 param body → 200400403
DELETE
/stages/invitation/invitations/{invite_uuid}/
Invitation Viewset
stages_invitation_invitations_destroy 1 param → 204400403
POST
/stages/invitation/invitations/{invite_uuid}/send_email/
Send invitation link via email to one or more addresses
stages_invitation_invitations_send_email_create 1 param body → 204400403
GET
/stages/invitation/invitations/{invite_uuid}/used_by/
Get a list of all objects that use this object
stages_invitation_invitations_used_by_list 1 param → 200400403
GET
/stages/invitation/stages/
InvitationStage Viewset
stages_invitation_stages_list 8 params → 200400403
POST
/stages/invitation/stages/
InvitationStage Viewset
stages_invitation_stages_create body → 201400403
GET
/stages/invitation/stages/{stage_uuid}/
InvitationStage Viewset
stages_invitation_stages_retrieve 1 param → 200400403
PUT
/stages/invitation/stages/{stage_uuid}/
InvitationStage Viewset
stages_invitation_stages_update 1 param body → 200400403
PATCH
/stages/invitation/stages/{stage_uuid}/
InvitationStage Viewset
stages_invitation_stages_partial_update 1 param body → 200400403
DELETE
/stages/invitation/stages/{stage_uuid}/
InvitationStage Viewset
stages_invitation_stages_destroy 1 param → 204400403
GET
/stages/invitation/stages/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_invitation_stages_used_by_list 1 param → 200400403
GET
/stages/mtls/
MutualTLSStage Viewset
stages_mtls_list 10 params → 200400403
POST
/stages/mtls/
MutualTLSStage Viewset
stages_mtls_create body → 201400403
GET
/stages/mtls/{stage_uuid}/
MutualTLSStage Viewset
stages_mtls_retrieve 1 param → 200400403
PUT
/stages/mtls/{stage_uuid}/
MutualTLSStage Viewset
stages_mtls_update 1 param body → 200400403
PATCH
/stages/mtls/{stage_uuid}/
MutualTLSStage Viewset
stages_mtls_partial_update 1 param body → 200400403
DELETE
/stages/mtls/{stage_uuid}/
MutualTLSStage Viewset
stages_mtls_destroy 1 param → 204400403
GET
/stages/mtls/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_mtls_used_by_list 1 param → 200400403
GET
/stages/password/
PasswordStage Viewset
stages_password_list 8 params → 200400403
POST
/stages/password/
PasswordStage Viewset
stages_password_create body → 201400403
GET
/stages/password/{stage_uuid}/
PasswordStage Viewset
stages_password_retrieve 1 param → 200400403
PUT
/stages/password/{stage_uuid}/
PasswordStage Viewset
stages_password_update 1 param body → 200400403
PATCH
/stages/password/{stage_uuid}/
PasswordStage Viewset
stages_password_partial_update 1 param body → 200400403
DELETE
/stages/password/{stage_uuid}/
PasswordStage Viewset
stages_password_destroy 1 param → 204400403
GET
/stages/password/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_password_used_by_list 1 param → 200400403
GET
/stages/prompt/prompts/
Prompt Viewset
stages_prompt_prompts_list 9 params → 200400403
POST
/stages/prompt/prompts/
Prompt Viewset
stages_prompt_prompts_create body → 201400403
GET
/stages/prompt/prompts/{prompt_uuid}/
Prompt Viewset
stages_prompt_prompts_retrieve 1 param → 200400403
PUT
/stages/prompt/prompts/{prompt_uuid}/
Prompt Viewset
stages_prompt_prompts_update 1 param body → 200400403
PATCH
/stages/prompt/prompts/{prompt_uuid}/
Prompt Viewset
stages_prompt_prompts_partial_update 1 param body → 200400403
DELETE
/stages/prompt/prompts/{prompt_uuid}/
Prompt Viewset
stages_prompt_prompts_destroy 1 param → 204400403
GET
/stages/prompt/prompts/{prompt_uuid}/used_by/
Get a list of all objects that use this object
stages_prompt_prompts_used_by_list 1 param → 200400403
POST
/stages/prompt/prompts/preview/
Preview a prompt as a challenge, just like a flow would receive
stages_prompt_prompts_preview_create body → 200400403
GET
/stages/prompt/stages/
PromptStage Viewset
stages_prompt_stages_list 8 params → 200400403
POST
/stages/prompt/stages/
PromptStage Viewset
stages_prompt_stages_create body → 201400403
GET
/stages/prompt/stages/{stage_uuid}/
PromptStage Viewset
stages_prompt_stages_retrieve 1 param → 200400403
PUT
/stages/prompt/stages/{stage_uuid}/
PromptStage Viewset
stages_prompt_stages_update 1 param body → 200400403
PATCH
/stages/prompt/stages/{stage_uuid}/
PromptStage Viewset
stages_prompt_stages_partial_update 1 param body → 200400403
DELETE
/stages/prompt/stages/{stage_uuid}/
PromptStage Viewset
stages_prompt_stages_destroy 1 param → 204400403
GET
/stages/prompt/stages/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_prompt_stages_used_by_list 1 param → 200400403
GET
/stages/redirect/
RedirectStage Viewset
stages_redirect_list 5 params → 200400403
POST
/stages/redirect/
RedirectStage Viewset
stages_redirect_create body → 201400403
GET
/stages/redirect/{stage_uuid}/
RedirectStage Viewset
stages_redirect_retrieve 1 param → 200400403
PUT
/stages/redirect/{stage_uuid}/
RedirectStage Viewset
stages_redirect_update 1 param body → 200400403
PATCH
/stages/redirect/{stage_uuid}/
RedirectStage Viewset
stages_redirect_partial_update 1 param body → 200400403
DELETE
/stages/redirect/{stage_uuid}/
RedirectStage Viewset
stages_redirect_destroy 1 param → 204400403
GET
/stages/redirect/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_redirect_used_by_list 1 param → 200400403
GET
/stages/source/
SourceStage Viewset
stages_source_list 8 params → 200400403
POST
/stages/source/
SourceStage Viewset
stages_source_create body → 201400403
GET
/stages/source/{stage_uuid}/
SourceStage Viewset
stages_source_retrieve 1 param → 200400403
PUT
/stages/source/{stage_uuid}/
SourceStage Viewset
stages_source_update 1 param body → 200400403
PATCH
/stages/source/{stage_uuid}/
SourceStage Viewset
stages_source_partial_update 1 param body → 200400403
DELETE
/stages/source/{stage_uuid}/
SourceStage Viewset
stages_source_destroy 1 param → 204400403
GET
/stages/source/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_source_used_by_list 1 param → 200400403
GET
/stages/user_delete/
UserDeleteStage Viewset
stages_user_delete_list 6 params → 200400403
POST
/stages/user_delete/
UserDeleteStage Viewset
stages_user_delete_create body → 201400403
GET
/stages/user_delete/{stage_uuid}/
UserDeleteStage Viewset
stages_user_delete_retrieve 1 param → 200400403
PUT
/stages/user_delete/{stage_uuid}/
UserDeleteStage Viewset
stages_user_delete_update 1 param body → 200400403
PATCH
/stages/user_delete/{stage_uuid}/
UserDeleteStage Viewset
stages_user_delete_partial_update 1 param body → 200400403
DELETE
/stages/user_delete/{stage_uuid}/
UserDeleteStage Viewset
stages_user_delete_destroy 1 param → 204400403
GET
/stages/user_delete/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_user_delete_used_by_list 1 param → 200400403
GET
/stages/user_login/
UserLoginStage Viewset
stages_user_login_list 12 params → 200400403
POST
/stages/user_login/
UserLoginStage Viewset
stages_user_login_create body → 201400403
GET
/stages/user_login/{stage_uuid}/
UserLoginStage Viewset
stages_user_login_retrieve 1 param → 200400403
PUT
/stages/user_login/{stage_uuid}/
UserLoginStage Viewset
stages_user_login_update 1 param body → 200400403
PATCH
/stages/user_login/{stage_uuid}/
UserLoginStage Viewset
stages_user_login_partial_update 1 param body → 200400403
DELETE
/stages/user_login/{stage_uuid}/
UserLoginStage Viewset
stages_user_login_destroy 1 param → 204400403
GET
/stages/user_login/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_user_login_used_by_list 1 param → 200400403
GET
/stages/user_logout/
UserLogoutStage Viewset
stages_user_logout_list 6 params → 200400403
POST
/stages/user_logout/
UserLogoutStage Viewset
stages_user_logout_create body → 201400403
GET
/stages/user_logout/{stage_uuid}/
UserLogoutStage Viewset
stages_user_logout_retrieve 1 param → 200400403
PUT
/stages/user_logout/{stage_uuid}/
UserLogoutStage Viewset
stages_user_logout_update 1 param body → 200400403
PATCH
/stages/user_logout/{stage_uuid}/
UserLogoutStage Viewset
stages_user_logout_partial_update 1 param body → 200400403
DELETE
/stages/user_logout/{stage_uuid}/
UserLogoutStage Viewset
stages_user_logout_destroy 1 param → 204400403
GET
/stages/user_logout/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_user_logout_used_by_list 1 param → 200400403
GET
/stages/user_write/
UserWriteStage Viewset
stages_user_write_list 11 params → 200400403
POST
/stages/user_write/
UserWriteStage Viewset
stages_user_write_create body → 201400403
GET
/stages/user_write/{stage_uuid}/
UserWriteStage Viewset
stages_user_write_retrieve 1 param → 200400403
PUT
/stages/user_write/{stage_uuid}/
UserWriteStage Viewset
stages_user_write_update 1 param body → 200400403
PATCH
/stages/user_write/{stage_uuid}/
UserWriteStage Viewset
stages_user_write_partial_update 1 param body → 200400403
DELETE
/stages/user_write/{stage_uuid}/
UserWriteStage Viewset
stages_user_write_destroy 1 param → 204400403
GET
/stages/user_write/{stage_uuid}/used_by/
Get a list of all objects that use this object
stages_user_write_used_by_list 1 param → 200400403

Schemas 169

The contract defines 169 schemas that model the data the API accepts and returns. The most detailed are EmailStage (21 properties), AuthenticatorEmailStage (21 properties), IdentificationStage (20 properties), AuthenticatorValidateStage (19 properties). Each schema is shown below with its type and property counts.

Stage
object
Stage Serializer
7 properties 7 required
PatchedAuthenticatorValidateStageRequest
object
AuthenticatorValidateStage Serializer
12 properties
AuthTypeEnum
string
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
FlowLayoutEnum
string
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
WebAuthnHintEnum
string
Autocomplete
object
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
UserFieldsEnum
string
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
DeniedActionEnum
string
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
UserTypeEnum
string
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
PolicyEngineMode
string
PaginatedIdentificationStageList
object
3 properties 3 required
PatchedAuthenticatorEndpointGDTCStageRequest
object
AuthenticatorEndpointGDTCStage Serializer
4 properties
DuoResponseEnum
string
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
CertAttributeEnum
string
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
BackendsEnum
string
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
UserAttributeEnum
string
Invitation
object
Invitation Serializer
8 properties 4 required
PromptChallenge
object
Initial challenge being sent, define fields
4 properties 1 required
AuthenticationEnum
string
DeviceClassesEnum
string
UsedByActionEnum
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
ProviderEnum
string
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
GeoipBindingEnum
string
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
DigitsEnum
string
PasswordStage
object
PasswordStage Serializer
11 properties 8 required
PatchedCaptchaStageRequest
object
CaptchaStage Serializer
10 properties
AuthenticatorEmailStageRequest
object
AuthenticatorEmailStage Serializer
15 properties 1 required
PromptTypeEnum
string
EmailStageRequest
object
EmailStage Serializer
16 properties 1 required
InvitationStage
object
InvitationStage Serializer
8 properties 7 required
StageModeEnum
string
PatchedDummyStageRequest
object
DummyStage Serializer
2 properties
AuthenticatorSMSStage
object
AuthenticatorSMSStage Serializer
17 properties 11 required
ConsentModeEnum
string
PatchedAuthenticatorSMSStageRequest
object
AuthenticatorSMSStage Serializer
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

authentik-stages-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 Sources API
Authentik Admin API
Authentik Agents API
Authentik Authenticators API
Where this information came from

This is an independent, third-party profile of Authentik Stages 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.