website/docs/releases/2024/v2024.4.md
OAuth/SAML as authentication factor :ak-enterprise Use an external provider as part of an MFA authentication flow, including custom implementations
SCIM Source :ak-preview Provision users and groups in authentik using an SCIM API
Configurable WebAuthn device restrictions Configure which types of WebAuthn devices can be used to enroll and validate for different authorization levels.
Performance improvements The API Endpoints to list Users, Groups, and Events have been optimized by 94%, 41% and 53% respectively
Configuration options migrated to the Admin interface
The following config options have been moved from the config file and can now be set using the Admin interface (under System -> Settings) or the API:
AUTHENTIK_DEFAULT_TOKEN_LENGTHWhen upgrading to 2024.4, the currently configured options will be automatically migrated to the database, and can be removed from the .env or helm values file afterwards.
Source stage :ak-enterprise
The source stage allows for an inclusion of a source as part of a flow. This can be used to link a user to a source as part of their authentication/enrollment, or it can be used as an external multi-factor to provide device health attestation for example.
For details refer to Source stage
SCIM Source :ak-preview
Provision users and groups in authentik using an SCIM API.
For details refer to SCIM Source
Configurable WebAuthn device restrictions
Configure which types of WebAuthn devices can be used to enroll and validate for different authorization levels.
For details refer to WebAuthn authenticator setup stage
Revamped UI for log messages
Log messages from several API endpoints are now shown with much greater detail, which helps with implementing custom policies and property mappings.
Python API Client
There's now an official API Client for Python: https://pypi.org/project/authentik-client/. This API Client can be used to create/update/delete objects within authentik as well as using the Flow executor to authenticate.
Configure LDAP sources to not store hashed password in authentik
When authentik is configured to federate with an LDAP source, upon authentication, authentik hashed the password and stored it in its own database. This allows authentication to function when LDAP is unreachable. Admins can now configure this behavior for when this is not desirable.
For details refer to LDAP Source
Configurable app password token expiring
Thanks @jmdilly for contributing this feature!
Admins can now configure the default token duration (which defaults to minutes=30) in the admin interface as specified above. This value can also be overridden per-user with the goauthentik.io/user/token-maximum-lifetime attribute.
This release does not introduce any new requirements.
To upgrade, download the new docker-compose file and update the Docker stack with the new version, using these commands:
wget -O docker-compose.yml https://goauthentik.io/version/2024.4/docker-compose.yml
docker compose up -d
The -O flag retains the downloaded file's name, overwriting any existing local file with the same name.
Upgrade the Helm Chart to the new version, using the following commands:
helm repo update
helm upgrade authentik authentik/authentik -f values.yaml --version ^2024.4
sub value when setting via mapping (#8677)__str__ can be called without any further lookups (cherry-pick #9480) (#9485)GET /sources/scim/POST /sources/scim/GET /sources/scim/{slug}/PUT /sources/scim/{slug}/DELETE /sources/scim/{slug}/PATCH /sources/scim/{slug}/GET /sources/scim/{slug}/used_by/GET /sources/scim_groups/POST /sources/scim_groups/GET /sources/scim_groups/{id}/PUT /sources/scim_groups/{id}/DELETE /sources/scim_groups/{id}/PATCH /sources/scim_groups/{id}/GET /sources/scim_groups/{id}/used_by/GET /sources/scim_users/POST /sources/scim_users/GET /sources/scim_users/{id}/PUT /sources/scim_users/{id}/DELETE /sources/scim_users/{id}/PATCH /sources/scim_users/{id}/GET /sources/scim_users/{id}/used_by/GET /stages/authenticator/webauthn_device_types/GET /stages/authenticator/webauthn_device_types/{aaguid}/GET /stages/source/POST /stages/source/GET /stages/source/{stage_uuid}/PUT /stages/source/{stage_uuid}/DELETE /stages/source/{stage_uuid}/PATCH /stages/source/{stage_uuid}/GET /stages/source/{stage_uuid}/used_by/POST /core/users/{id}/recovery/POST /core/users/{id}/recovery_email/GET /core/users/{id}/recovery/GET /core/users/{id}/recovery_email/GET /admin/apps/GET /admin/models/GET /admin/settings/Changed response : 200 OK
application/json
Added property default_token_duration (string)
Default token duration
Added property default_token_length (integer)
Default token length
PUT /admin/settings/Changed content type : application/json
Added property default_token_duration (string)
Default token duration
Added property default_token_length (integer)
Default token length
Changed response : 200 OK
application/json
Added property default_token_duration (string)
Default token duration
Added property default_token_length (integer)
Default token length
PATCH /admin/settings/Changed content type : application/json
Added property default_token_duration (string)
Default token duration
Added property default_token_length (integer)
Default token length
Changed response : 200 OK
application/json
Added property default_token_duration (string)
Default token duration
Added property default_token_length (integer)
Default token length
GET /admin/system/POST /admin/system/GET /admin/version/Changed response : 200 OK
Changed content type : application/json
New required properties:
version_latest_validversion_latest_valid (boolean)
Check if latest version is valid
GET /admin/workers/GET /authenticators/admin/all/GET /authenticators/admin/duo/{id}/PUT /authenticators/admin/duo/{id}/DELETE /authenticators/admin/duo/{id}/PATCH /authenticators/admin/duo/{id}/GET /authenticators/admin/sms/{id}/PUT /authenticators/admin/sms/{id}/DELETE /authenticators/admin/sms/{id}/PATCH /authenticators/admin/sms/{id}/GET /authenticators/admin/totp/{id}/PUT /authenticators/admin/totp/{id}/DELETE /authenticators/admin/totp/{id}/PATCH /authenticators/admin/totp/{id}/GET /authenticators/admin/webauthn/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Property aaguid (string)
Property description (string)
Added property aaguid (string)
PUT /authenticators/admin/webauthn/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
DELETE /authenticators/admin/webauthn/{id}/PATCH /authenticators/admin/webauthn/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
GET /authenticators/all/GET /authenticators/duo/{id}/PUT /authenticators/duo/{id}/DELETE /authenticators/duo/{id}/PATCH /authenticators/duo/{id}/GET /authenticators/sms/{id}/PUT /authenticators/sms/{id}/DELETE /authenticators/sms/{id}/PATCH /authenticators/sms/{id}/GET /authenticators/totp/{id}/PUT /authenticators/totp/{id}/DELETE /authenticators/totp/{id}/PATCH /authenticators/totp/{id}/GET /authenticators/webauthn/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
PUT /authenticators/webauthn/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
DELETE /authenticators/webauthn/{id}/PATCH /authenticators/webauthn/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
GET /core/applications/{slug}/check_access/Changed response : 200 OK
application/json
Changed property log_messages (array)
Changed items (object): > Single log message with all context logged.
New required properties:
attributeseventlog_levelloggertimestampAdded property timestamp (string)
Added property log_level (string)
Enum values:
criticalexceptionerrorwarnwarninginfodebugnotsetAdded property logger (string)
Added property event (string)
Added property attributes (object)
GET /core/applications/{slug}/metrics/POST /core/applications/{slug}/set_icon/POST /core/applications/{slug}/set_icon_url/GET /core/authenticated_sessions/{uuid}/DELETE /core/authenticated_sessions/{uuid}/GET /core/brands/{brand_uuid}/PUT /core/brands/{brand_uuid}/DELETE /core/brands/{brand_uuid}/PATCH /core/brands/{brand_uuid}/POST /core/groups/{group_uuid}/add_user/POST /core/groups/{group_uuid}/remove_user/POST /core/tokens/{identifier}/set_key/GET /core/tokens/{identifier}/view_key/POST /core/users/{id}/impersonate/POST /core/users/{id}/set_password/GET /core/users/impersonate_end/GET /core/users/paths/POST /core/users/service_account/GET /crypto/certificatekeypairs/{kp_uuid}/PUT /crypto/certificatekeypairs/{kp_uuid}/DELETE /crypto/certificatekeypairs/{kp_uuid}/PATCH /crypto/certificatekeypairs/{kp_uuid}/GET /crypto/certificatekeypairs/{kp_uuid}/view_certificate/GET /crypto/certificatekeypairs/{kp_uuid}/view_private_key/POST /crypto/certificatekeypairs/generate/GET /enterprise/license/{license_uuid}/PUT /enterprise/license/{license_uuid}/DELETE /enterprise/license/{license_uuid}/PATCH /enterprise/license/{license_uuid}/GET /enterprise/license/forecast/GET /enterprise/license/get_install_id/GET /enterprise/license/summary/GET /events/events/actions/GET /events/events/per_month/GET /events/events/top_per_user/GET /events/events/volume/POST /events/notifications/mark_all_seen/POST /events/system_tasks/{uuid}/run/POST /events/transports/{uuid}/test/GET /flows/instances/{slug}/diagram/GET /flows/instances/{slug}/execute/GET /flows/instances/{slug}/export/POST /flows/instances/{slug}/set_background/POST /flows/instances/{slug}/set_background_url/POST /flows/instances/cache_clear/GET /flows/instances/cache_info/POST /flows/instances/import/Changed response : 204 No Content
application/json
Changed property logs (array)
Changed items (object): > Single log message with all context logged.
New required properties:
attributeseventlog_levelloggertimestampAdded property timestamp (string)
Added property log_level (string)
Added property logger (string)
Added property event (string)
Added property attributes (object)
Changed response : 400 Bad Request
application/json
Changed property logs (array)
Changed items (object): > Single log message with all context logged.
New required properties:
attributeseventlog_levelloggertimestampAdded property timestamp (string)
Added property log_level (string)
Added property logger (string)
Added property event (string)
Added property attributes (object)
GET /managed/blueprints/{instance_uuid}/Changed response : 200 OK
application/json
status (string)PUT /managed/blueprints/{instance_uuid}/Changed response : 200 OK
application/json
status (string)DELETE /managed/blueprints/{instance_uuid}/PATCH /managed/blueprints/{instance_uuid}/Changed response : 200 OK
application/json
status (string)POST /managed/blueprints/{instance_uuid}/apply/Changed response : 200 OK
application/json
status (string)GET /managed/blueprints/available/GET /outposts/instances/{uuid}/health/GET /outposts/instances/default_settings/GET /outposts/proxy/{id}/Changed response : 200 OK
application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
GET /outposts/radius/{id}/GET /outposts/service_connections/all/{uuid}/DELETE /outposts/service_connections/all/{uuid}/GET /outposts/service_connections/all/{uuid}/state/GET /outposts/service_connections/all/types/GET /outposts/service_connections/docker/{uuid}/PUT /outposts/service_connections/docker/{uuid}/DELETE /outposts/service_connections/docker/{uuid}/PATCH /outposts/service_connections/docker/{uuid}/GET /outposts/service_connections/kubernetes/{uuid}/PUT /outposts/service_connections/kubernetes/{uuid}/DELETE /outposts/service_connections/kubernetes/{uuid}/PATCH /outposts/service_connections/kubernetes/{uuid}/GET /policies/all/{policy_uuid}/DELETE /policies/all/{policy_uuid}/POST /policies/all/{policy_uuid}/test/Changed response : 200 OK
application/json
Changed property log_messages (array)
Changed items (object): > Single log message with all context logged.
New required properties:
attributeseventlog_levelloggertimestampAdded property timestamp (string)
Added property log_level (string)
Added property logger (string)
Added property event (string)
Added property attributes (object)
POST /policies/all/cache_clear/GET /policies/all/cache_info/GET /policies/all/types/GET /policies/dummy/{policy_uuid}/PUT /policies/dummy/{policy_uuid}/DELETE /policies/dummy/{policy_uuid}/PATCH /policies/dummy/{policy_uuid}/GET /policies/event_matcher/{policy_uuid}/Changed response : 200 OK
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
PUT /policies/event_matcher/{policy_uuid}/Changed content type : application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
Changed response : 200 OK
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
DELETE /policies/event_matcher/{policy_uuid}/PATCH /policies/event_matcher/{policy_uuid}/Changed content type : application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
Changed response : 200 OK
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
GET /policies/expression/{policy_uuid}/PUT /policies/expression/{policy_uuid}/DELETE /policies/expression/{policy_uuid}/PATCH /policies/expression/{policy_uuid}/GET /policies/password/{policy_uuid}/PUT /policies/password/{policy_uuid}/DELETE /policies/password/{policy_uuid}/PATCH /policies/password/{policy_uuid}/GET /policies/password_expiry/{policy_uuid}/PUT /policies/password_expiry/{policy_uuid}/DELETE /policies/password_expiry/{policy_uuid}/PATCH /policies/password_expiry/{policy_uuid}/GET /policies/reputation/{policy_uuid}/PUT /policies/reputation/{policy_uuid}/DELETE /policies/reputation/{policy_uuid}/PATCH /policies/reputation/{policy_uuid}/GET /policies/reputation/scores/{reputation_uuid}/DELETE /policies/reputation/scores/{reputation_uuid}/GET /propertymappings/all/{pm_uuid}/DELETE /propertymappings/all/{pm_uuid}/POST /propertymappings/all/{pm_uuid}/test/GET /propertymappings/all/types/GET /propertymappings/ldap/{pm_uuid}/PUT /propertymappings/ldap/{pm_uuid}/DELETE /propertymappings/ldap/{pm_uuid}/PATCH /propertymappings/ldap/{pm_uuid}/GET /propertymappings/notification/{pm_uuid}/PUT /propertymappings/notification/{pm_uuid}/DELETE /propertymappings/notification/{pm_uuid}/PATCH /propertymappings/notification/{pm_uuid}/GET /propertymappings/rac/{pm_uuid}/PUT /propertymappings/rac/{pm_uuid}/DELETE /propertymappings/rac/{pm_uuid}/PATCH /propertymappings/rac/{pm_uuid}/GET /propertymappings/saml/{pm_uuid}/PUT /propertymappings/saml/{pm_uuid}/DELETE /propertymappings/saml/{pm_uuid}/PATCH /propertymappings/saml/{pm_uuid}/GET /propertymappings/scim/{pm_uuid}/PUT /propertymappings/scim/{pm_uuid}/DELETE /propertymappings/scim/{pm_uuid}/PATCH /propertymappings/scim/{pm_uuid}/GET /propertymappings/scope/{pm_uuid}/PUT /propertymappings/scope/{pm_uuid}/DELETE /propertymappings/scope/{pm_uuid}/PATCH /propertymappings/scope/{pm_uuid}/GET /providers/all/{id}/DELETE /providers/all/{id}/GET /providers/all/types/GET /providers/oauth2/{id}/Changed response : 200 OK
application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
PUT /providers/oauth2/{id}/Changed content type : application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed response : 200 OK
application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
DELETE /providers/oauth2/{id}/PATCH /providers/oauth2/{id}/Changed content type : application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed response : 200 OK
application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
GET /providers/oauth2/{id}/preview_user/GET /providers/oauth2/{id}/setup_urls/GET /providers/proxy/{id}/Changed response : 200 OK
application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
PUT /providers/proxy/{id}/Changed content type : application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
Changed response : 200 OK
application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
DELETE /providers/proxy/{id}/PATCH /providers/proxy/{id}/Changed content type : application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
Changed response : 200 OK
application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
GET /providers/rac/{id}/PUT /providers/rac/{id}/DELETE /providers/rac/{id}/PATCH /providers/rac/{id}/GET /providers/radius/{id}/PUT /providers/radius/{id}/DELETE /providers/radius/{id}/PATCH /providers/radius/{id}/GET /providers/saml/{id}/metadata/GET /providers/saml/{id}/preview_user/POST /providers/saml/import_metadata/GET /providers/scim/{id}/PUT /providers/scim/{id}/DELETE /providers/scim/{id}/PATCH /providers/scim/{id}/GET /rbac/permissions/{id}/GET /rbac/roles/{uuid}/PUT /rbac/roles/{uuid}/DELETE /rbac/roles/{uuid}/PATCH /rbac/roles/{uuid}/GET /schema/POST /sources/all/{slug}/set_icon/POST /sources/all/{slug}/set_icon_url/GET /sources/all/types/GET /sources/all/user_settings/GET /sources/ldap/{slug}/debug/GET /sources/oauth/source_types/POST /sources/plex/redeem_token_authenticated/GET /sources/saml/{slug}/metadata/GET /stages/all/types/GET /stages/all/user_settings/POST /stages/authenticator/duo/{stage_uuid}/import_device_manual/POST /stages/authenticator/duo/{stage_uuid}/import_devices_automatic/GET /stages/email/templates/GET /admin/metrics/POST /authenticators/admin/duo/GET /authenticators/admin/duo/POST /authenticators/admin/sms/GET /authenticators/admin/sms/DELETE /authenticators/admin/static/{id}/GET /authenticators/admin/static/{id}/PUT /authenticators/admin/static/{id}/PATCH /authenticators/admin/static/{id}/POST /authenticators/admin/totp/GET /authenticators/admin/totp/POST /authenticators/admin/webauthn/Changed response : 201 Created
Changed content type : application/json
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
GET /authenticators/admin/webauthn/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for WebAuthn authenticator devices
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
GET /authenticators/duo/GET /authenticators/duo/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /authenticators/sms/GET /authenticators/sms/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /authenticators/static/{id}/GET /authenticators/static/{id}/PUT /authenticators/static/{id}/PATCH /authenticators/static/{id}/GET /authenticators/static/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /authenticators/totp/GET /authenticators/totp/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /authenticators/webauthn/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for WebAuthn authenticator devices
New required properties:
aaguiddevice_typeAdded property device_type (object)
Added property aaguid (string)
GET /authenticators/webauthn/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /core/applications/{slug}/GET /core/applications/{slug}/Changed response : 200 OK
application/json
policy_engine_mode (string)PUT /core/applications/{slug}/Changed content type : application/json
policy_engine_mode (string)Changed response : 200 OK
application/json
policy_engine_mode (string)PATCH /core/applications/{slug}/Changed content type : application/json
policy_engine_mode (string)Changed response : 200 OK
application/json
policy_engine_mode (string)GET /core/applications/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /core/authenticated_sessions/GET /core/authenticated_sessions/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /core/brands/GET /core/brands/GET /core/brands/{brand_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /core/brands/current/Changed response : 200 OK
application/json
ui_theme (string)DELETE /core/groups/{group_uuid}/GET /core/groups/{group_uuid}/PUT /core/groups/{group_uuid}/PATCH /core/groups/{group_uuid}/GET /core/groups/{group_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /core/tokens/{identifier}/GET /core/tokens/{identifier}/Changed response : 200 OK
application/json
Changed property intent (string)
Changed property user_obj (object)
User Serializer
type (string)PUT /core/tokens/{identifier}/Changed content type : application/json
intent (string)Changed response : 200 OK
application/json
Changed property intent (string)
Changed property user_obj (object)
User Serializer
type (string)PATCH /core/tokens/{identifier}/Changed content type : application/json
intent (string)Changed response : 200 OK
application/json
Changed property intent (string)
Changed property user_obj (object)
User Serializer
type (string)GET /core/tokens/{identifier}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /core/user_consent/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /core/users/{id}/GET /core/users/{id}/Changed response : 200 OK
application/json
type (string)PUT /core/users/{id}/Changed content type : application/json
type (string)Changed response : 200 OK
application/json
type (string)PATCH /core/users/{id}/Changed content type : application/json
type (string)Changed response : 200 OK
application/json
type (string)GET /core/users/{id}/metrics/GET /core/users/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /crypto/certificatekeypairs/GET /crypto/certificatekeypairs/GET /crypto/certificatekeypairs/{kp_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /enterprise/license/GET /enterprise/license/GET /enterprise/license/{license_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /events/events/{event_uuid}/GET /events/events/{event_uuid}/Changed response : 200 OK
application/json
action (string)PUT /events/events/{event_uuid}/Changed content type : application/json
action (string)Changed response : 200 OK
application/json
action (string)PATCH /events/events/{event_uuid}/Changed content type : application/json
action (string)Changed response : 200 OK
application/json
action (string)GET /events/notifications/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /events/rules/{pbm_uuid}/GET /events/rules/{pbm_uuid}/Changed response : 200 OK
application/json
severity (string)
Controls which severity level the created notifications will have.
PUT /events/rules/{pbm_uuid}/Changed content type : application/json
severity (string)
Controls which severity level the created notifications will have.
Changed response : 200 OK
application/json
severity (string)
Controls which severity level the created notifications will have.
PATCH /events/rules/{pbm_uuid}/Changed content type : application/json
severity (string)
Controls which severity level the created notifications will have.
Changed response : 200 OK
application/json
severity (string)
Controls which severity level the created notifications will have.
GET /events/rules/{pbm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /events/system_tasks/{uuid}/Changed response : 200 OK
application/json
Changed property messages (array)
Changed items (string -> object): > Single log message with all context logged.
Changed property status (string)
DELETE /events/transports/{uuid}/GET /events/transports/{uuid}/Changed response : 200 OK
application/json
mode (string)PUT /events/transports/{uuid}/Changed content type : application/json
mode (string)Changed response : 200 OK
application/json
mode (string)PATCH /events/transports/{uuid}/Changed content type : application/json
mode (string)Changed response : 200 OK
application/json
mode (string)GET /events/transports/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /flows/bindings/{fsb_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /flows/instances/{slug}/GET /flows/instances/{slug}/Changed response : 200 OK
application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /flows/instances/{slug}/Changed content type : application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /flows/instances/{slug}/Changed content type : application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /flows/instances/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /managed/blueprints/Changed response : 201 Created
application/json
status (string)GET /managed/blueprints/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Info about a single blueprint instance file
status (string)GET /managed/blueprints/{instance_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /oauth2/access_tokens/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /oauth2/authorization_codes/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /oauth2/refresh_tokens/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /outposts/instances/{uuid}/GET /outposts/instances/{uuid}/Changed response : 200 OK
application/json
type (string)PUT /outposts/instances/{uuid}/Changed content type : application/json
type (string)Changed response : 200 OK
application/json
type (string)PATCH /outposts/instances/{uuid}/Changed content type : application/json
type (string)Changed response : 200 OK
application/json
type (string)GET /outposts/instances/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /outposts/ldap/{id}/Changed response : 200 OK
application/json
search_mode (string)GET /outposts/proxy/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Proxy provider serializer for outposts
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
GET /outposts/radius/GET /outposts/service_connections/all/GET /outposts/service_connections/all/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /outposts/service_connections/docker/GET /outposts/service_connections/docker/GET /outposts/service_connections/docker/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /outposts/service_connections/kubernetes/GET /outposts/service_connections/kubernetes/GET /outposts/service_connections/kubernetes/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /policies/all/GET /policies/all/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /policies/bindings/{policy_binding_uuid}/GET /policies/bindings/{policy_binding_uuid}/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
type (string)PUT /policies/bindings/{policy_binding_uuid}/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
type (string)PATCH /policies/bindings/{policy_binding_uuid}/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
type (string)GET /policies/bindings/{policy_binding_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /policies/dummy/GET /policies/dummy/GET /policies/dummy/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /policies/event_matcher/Changed content type : application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
Changed response : 201 Created
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
GET /policies/event_matcher/Changed: action in query
Match created events with this action type. When left empty, all action types will be matched.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Event Matcher Policy Serializer
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.sources.scimauthentik.enterprise.stages.sourceChanged property model (string)
Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
GET /policies/event_matcher/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /policies/expression/GET /policies/expression/GET /policies/expression/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /policies/password/GET /policies/password/GET /policies/password/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /policies/password_expiry/GET /policies/password_expiry/GET /policies/password_expiry/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /policies/reputation/GET /policies/reputation/GET /policies/reputation/{policy_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /policies/reputation/scores/GET /policies/reputation/scores/{reputation_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /propertymappings/all/GET /propertymappings/all/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /propertymappings/ldap/GET /propertymappings/ldap/GET /propertymappings/ldap/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /propertymappings/notification/GET /propertymappings/notification/GET /propertymappings/notification/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /propertymappings/rac/GET /propertymappings/rac/GET /propertymappings/rac/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /propertymappings/saml/GET /propertymappings/saml/GET /propertymappings/saml/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /propertymappings/scim/GET /propertymappings/scim/GET /propertymappings/scim/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /propertymappings/scope/GET /propertymappings/scope/GET /propertymappings/scope/{pm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /providers/all/GET /providers/all/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /providers/ldap/{id}/GET /providers/ldap/{id}/Changed response : 200 OK
application/json
search_mode (string)PUT /providers/ldap/{id}/Changed content type : application/json
search_mode (string)Changed response : 200 OK
application/json
search_mode (string)PATCH /providers/ldap/{id}/Changed content type : application/json
search_mode (string)Changed response : 200 OK
application/json
search_mode (string)GET /providers/ldap/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /providers/oauth2/Changed content type : application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed response : 201 Created
application/json
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
GET /providers/oauth2/Changed: client_type in query
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed: issuer_mode in query
Configure how the issuer field of the ID Token should be filled.
Changed: sub_mode in query
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
GET /providers/oauth2/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /providers/proxy/Changed content type : application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
Changed response : 201 Created
application/json
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
GET /providers/proxy/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ProxyProvider Serializer
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
GET /providers/proxy/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /providers/rac/GET /providers/rac/GET /providers/rac/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /providers/radius/GET /providers/radius/GET /providers/radius/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /providers/saml/{id}/GET /providers/saml/{id}/Changed response : 200 OK
application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
PUT /providers/saml/{id}/Changed content type : application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Changed response : 200 OK
application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
PATCH /providers/saml/{id}/Changed content type : application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Changed response : 200 OK
application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
GET /providers/saml/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /providers/scim/GET /providers/scim/GET /providers/scim/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /rac/connection_tokens/{connection_token_uuid}/Changed: connection_token_uuid in path
A UUID string identifying this RAC Connection token.
GET /rac/connection_tokens/{connection_token_uuid}/Changed: connection_token_uuid in path
A UUID string identifying this RAC Connection token.
Changed response : 200 OK
Changed content type : application/json
New optional properties:
pkChanged property pk (string)
Changed property endpoint (string)
Changed property endpoint_obj (object)
Endpoint Serializer
Changed property protocol (string)
Changed property auth_mode (string)
PUT /rac/connection_tokens/{connection_token_uuid}/Changed: connection_token_uuid in path
A UUID string identifying this RAC Connection token.
Changed content type : application/json
New required properties:
endpointAdded property pk (string)
Added property endpoint (string)
Changed response : 200 OK
Changed content type : application/json
New optional properties:
pkChanged property pk (string)
Changed property endpoint (string)
Changed property endpoint_obj (object)
Endpoint Serializer
Changed property protocol (string)
Changed property auth_mode (string)
PATCH /rac/connection_tokens/{connection_token_uuid}/Changed: connection_token_uuid in path
A UUID string identifying this RAC Connection token.
Changed content type : application/json
Added property pk (string)
Added property endpoint (string)
Changed response : 200 OK
Changed content type : application/json
New optional properties:
pkChanged property pk (string)
Changed property endpoint (string)
Changed property endpoint_obj (object)
Endpoint Serializer
Changed property protocol (string)
Changed property auth_mode (string)
GET /rac/connection_tokens/{connection_token_uuid}/used_by/Changed: connection_token_uuid in path
A UUID string identifying this RAC Connection token.
Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /rac/endpoints/{pbm_uuid}/GET /rac/endpoints/{pbm_uuid}/Changed response : 200 OK
application/json
Changed property protocol (string)
Changed property auth_mode (string)
PUT /rac/endpoints/{pbm_uuid}/Changed content type : application/json
Changed property protocol (string)
Changed property auth_mode (string)
Changed response : 200 OK
application/json
Changed property protocol (string)
Changed property auth_mode (string)
PATCH /rac/endpoints/{pbm_uuid}/Changed content type : application/json
Changed property protocol (string)
Changed property auth_mode (string)
Changed response : 200 OK
application/json
Changed property protocol (string)
Changed property auth_mode (string)
GET /rac/endpoints/{pbm_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /rbac/permissions/POST /rbac/permissions/assigned_by_roles/{uuid}/assign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
PATCH /rbac/permissions/assigned_by_roles/{uuid}/unassign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
POST /rbac/permissions/assigned_by_users/{id}/assign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
PATCH /rbac/permissions/assigned_by_users/{id}/unassign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_sources_scim.scimsource
authentik_stages_authenticator_webauthn.authenticatorwebauthnstage
authentik_stages_source.sourcestage
Removed enum value:
authentik_stages_authenticator_webauthn.authenticatewebauthnstage
GET /rbac/permissions/roles/GET /rbac/permissions/users/POST /rbac/roles/GET /rbac/roles/GET /rbac/roles/{uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /root/config/Changed response : 200 OK
application/json
Changed property capabilities (array)
Changed items (string):
DELETE /sources/all/{slug}/GET /sources/all/{slug}/Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/all/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/ldap/{slug}/GET /sources/ldap/{slug}/Changed response : 200 OK
application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PUT /sources/ldap/{slug}/Changed content type : application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed response : 200 OK
application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PATCH /sources/ldap/{slug}/Changed content type : application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed response : 200 OK
application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/ldap/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/oauth/{slug}/GET /sources/oauth/{slug}/Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabPUT /sources/oauth/{slug}/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabChanged response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabPATCH /sources/oauth/{slug}/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabChanged response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabGET /sources/oauth/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/plex/{slug}/GET /sources/plex/{slug}/Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PUT /sources/plex/{slug}/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PATCH /sources/plex/{slug}/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/plex/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/saml/{slug}/GET /sources/saml/{slug}/Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
PUT /sources/saml/{slug}/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
PATCH /sources/saml/{slug}/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Changed response : 200 OK
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
GET /sources/saml/{slug}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/user_connections/all/{id}/GET /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PUT /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PATCH /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/all/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/user_connections/oauth/{id}/GET /sources/user_connections/oauth/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PUT /sources/user_connections/oauth/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PATCH /sources/user_connections/oauth/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/oauth/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/user_connections/plex/{id}/GET /sources/user_connections/plex/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PUT /sources/user_connections/plex/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PATCH /sources/user_connections/plex/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/plex/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /sources/user_connections/saml/{id}/GET /sources/user_connections/saml/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PUT /sources/user_connections/saml/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
PATCH /sources/user_connections/saml/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/saml/{id}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/all/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /stages/authenticator/duo/{stage_uuid}/enrollment_status/Changed response : 200 OK
application/json
duo_response (string)GET /stages/authenticator/duo/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/authenticator/sms/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/authenticator/static/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/authenticator/totp/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/authenticator/validate/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/authenticator/webauthn/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/captcha/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/consent/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/deny/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/dummy/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/email/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/identification/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)DELETE /stages/invitation/invitations/{invite_uuid}/GET /stages/invitation/invitations/{invite_uuid}/Changed response : 200 OK
application/json
Changed property flow_obj (object)
Flow Serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/invitation/invitations/{invite_uuid}/Changed response : 200 OK
application/json
Changed property flow_obj (object)
Flow Serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/invitation/invitations/{invite_uuid}/Changed response : 200 OK
application/json
Changed property flow_obj (object)
Flow Serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/invitation/invitations/{invite_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/invitation/stages/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/password/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/prompt/prompts/{prompt_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/prompt/stages/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/user_delete/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/user_login/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/user_logout/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)GET /stages/user_write/{stage_uuid}/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
action (string)POST /authenticators/admin/static/GET /authenticators/admin/static/GET /authenticators/static/POST /core/applications/Changed content type : application/json
policy_engine_mode (string)Changed response : 201 Created
application/json
policy_engine_mode (string)GET /core/applications/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Application Serializer
policy_engine_mode (string)POST /core/groups/GET /core/groups/Added: include_users in query
POST /core/tokens/Changed content type : application/json
intent (string)Changed response : 201 Created
application/json
Changed property intent (string)
Changed property user_obj (object)
User Serializer
type (string)GET /core/tokens/Changed: intent in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Token Serializer
Changed property intent (string)
Changed property user_obj (object)
User Serializer
type (string)DELETE /core/user_consent/{id}/GET /core/user_consent/{id}/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
type (string)Changed property application (object)
Application Serializer
policy_engine_mode (string)POST /core/users/Changed content type : application/json
type (string)Changed response : 201 Created
application/json
type (string)GET /core/users/Added: include_groups in query
Changed: type in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User Serializer
type (string)GET /core/users/me/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer for information a user can retrieve about themselves
type (string)POST /events/events/Changed content type : application/json
action (string)Changed response : 201 Created
application/json
action (string)GET /events/events/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Event Serializer
action (string)DELETE /events/notifications/{uuid}/GET /events/notifications/{uuid}/Changed response : 200 OK
application/json
Changed property severity (string)
Changed property event (object)
Event Serializer
action (string)PUT /events/notifications/{uuid}/Changed content type : application/json
Changed property event (object)
Event Serializer
action (string)Changed response : 200 OK
application/json
Changed property severity (string)
Changed property event (object)
Event Serializer
action (string)PATCH /events/notifications/{uuid}/Changed content type : application/json
Changed property event (object)
Event Serializer
action (string)Changed response : 200 OK
application/json
Changed property severity (string)
Changed property event (object)
Event Serializer
action (string)POST /events/rules/Changed content type : application/json
severity (string)
Controls which severity level the created notifications will have.
Changed response : 201 Created
application/json
severity (string)
Controls which severity level the created notifications will have.
GET /events/rules/Changed: severity in query
Controls which severity level the created notifications will have.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > NotificationRule Serializer
severity (string)
Controls which severity level the created notifications will have.
GET /events/system_tasks/Changed: status in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serialize TaskInfo and TaskResult
Changed property messages (array)
Changed items (string -> object): > Single log message with all context logged.
Changed property status (string)
POST /events/transports/Changed content type : application/json
mode (string)Changed response : 201 Created
application/json
mode (string)GET /events/transports/Changed: mode in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > NotificationTransport Serializer
mode (string)DELETE /flows/bindings/{fsb_uuid}/GET /flows/bindings/{fsb_uuid}/Changed response : 200 OK
application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property layout (string)
PUT /flows/bindings/{fsb_uuid}/Changed content type : application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed response : 200 OK
application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property layout (string)
PATCH /flows/bindings/{fsb_uuid}/Changed content type : application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed response : 200 OK
application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property layout (string)
POST /flows/instances/Changed content type : application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /flows/instances/Changed: denied_action in query
Configure what should happen when a flow denies access to a user.
Changed: designation in query
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Flow Serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /oauth2/access_tokens/{id}/GET /oauth2/access_tokens/{id}/Changed response : 200 OK
application/json
Changed property provider (object)
OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed property user (object)
User Serializer
type (string)DELETE /oauth2/authorization_codes/{id}/GET /oauth2/authorization_codes/{id}/Changed response : 200 OK
application/json
Changed property provider (object)
OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed property user (object)
User Serializer
type (string)DELETE /oauth2/refresh_tokens/{id}/GET /oauth2/refresh_tokens/{id}/Changed response : 200 OK
application/json
Changed property provider (object)
OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed property user (object)
User Serializer
type (string)POST /outposts/instances/Changed content type : application/json
type (string)Changed response : 201 Created
application/json
type (string)GET /outposts/instances/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Outpost Serializer
type (string)GET /outposts/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAPProvider Serializer
search_mode (string)POST /policies/bindings/Changed response : 201 Created
application/json
Changed property user_obj (object)
User Serializer
type (string)GET /policies/bindings/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PolicyBinding Serializer
Changed property user_obj (object)
User Serializer
type (string)POST /providers/ldap/Changed content type : application/json
search_mode (string)Changed response : 201 Created
application/json
search_mode (string)GET /providers/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAPProvider Serializer
search_mode (string)POST /providers/saml/Changed content type : application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Changed response : 201 Created
application/json
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
GET /providers/saml/Changed: digest_algorithm in query
Changed: signature_algorithm in query
Changed: sp_binding in query
This determines how authentik sends the response back to the Service Provider.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLProvider Serializer
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
GET /providers/scim/{id}/sync_status/Changed response : 200 OK
application/json
Changed property tasks (array)
Changed items (object): > Serialize TaskInfo and TaskResult
Changed property messages (array)
Changed items (string -> object): > Single log message with all context logged.
Changed property status (string)
GET /rac/connection_tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ConnectionToken Serializer
New optional properties:
pkChanged property pk (string)
Changed property endpoint (string)
Changed property endpoint_obj (object)
Endpoint Serializer
Changed property protocol (string)
Changed property auth_mode (string)
POST /rac/endpoints/Changed content type : application/json
Changed property protocol (string)
Changed property auth_mode (string)
Changed response : 201 Created
application/json
Changed property protocol (string)
Changed property auth_mode (string)
GET /rac/endpoints/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Endpoint Serializer
Changed property protocol (string)
Changed property auth_mode (string)
GET /rbac/permissions/assigned_by_roles/Changed: model in query
GET /rbac/permissions/assigned_by_users/Changed: model in query
GET /sources/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
POST /sources/ldap/Changed content type : application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed response : 201 Created
application/json
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/ldap/Added: password_login_update_internal_password in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAP Source Serializer
Added property password_login_update_internal_password (boolean)
Update internal authentik password when login succeeds with LDAP
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/ldap/{slug}/sync_status/Changed response : 200 OK
application/json
Changed property tasks (array)
Changed items (object): > Serialize TaskInfo and TaskResult
Changed property messages (array)
Changed items (string -> object): > Single log message with all context logged.
Changed property status (string)
POST /sources/oauth/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabChanged response : 201 Created
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabGET /sources/oauth/Changed: policy_engine_mode in query
Changed: user_matching_mode in query
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed property provider_type (string)
Added enum value:
gitlabPOST /sources/plex/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
Changed response : 201 Created
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/plex/Changed: policy_engine_mode in query
Changed: user_matching_mode in query
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Plex Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
POST /sources/plex/redeem_token/Changed response : 200 OK
application/json
Changed property type (string)
Changed property flow_info (object)
Contextual flow information for a challenge
layout (string)POST /sources/saml/Changed content type : application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Changed response : 201 Created
application/json
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
GET /sources/saml/Changed: binding_type in query
Changed: digest_algorithm in query
Changed: name_id_policy in query
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed: policy_engine_mode in query
Changed: signature_algorithm in query
Changed: user_matching_mode in query
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLSource Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property name_id_policy (string)
NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.
Changed property policy_engine_mode (string)
Changed property binding_type (string)
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
GET /sources/user_connections/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
POST /sources/user_connections/oauth/Changed response : 201 Created
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/oauth/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
POST /sources/user_connections/plex/Changed response : 201 Created
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/plex/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Plex Source connection Serializer
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
POST /sources/user_connections/saml/Changed response : 201 Created
application/json
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
GET /sources/user_connections/saml/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAML Source Serializer
Changed property source (object)
Source Serializer
Changed property user_matching_mode (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property policy_engine_mode (string)
DELETE /stages/all/{stage_uuid}/GET /stages/all/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/authenticator/duo/{stage_uuid}/GET /stages/authenticator/duo/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/authenticator/duo/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/authenticator/duo/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/authenticator/sms/{stage_uuid}/GET /stages/authenticator/sms/{stage_uuid}/Changed response : 200 OK
application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/authenticator/sms/{stage_uuid}/Changed content type : application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/authenticator/sms/{stage_uuid}/Changed content type : application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/authenticator/static/{stage_uuid}/GET /stages/authenticator/static/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/authenticator/static/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/authenticator/static/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/authenticator/totp/{stage_uuid}/GET /stages/authenticator/totp/{stage_uuid}/Changed response : 200 OK
application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/authenticator/totp/{stage_uuid}/Changed content type : application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/authenticator/totp/{stage_uuid}/Changed content type : application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/authenticator/validate/{stage_uuid}/GET /stages/authenticator/validate/{stage_uuid}/Changed response : 200 OK
Changed content type : application/json
New required properties:
webauthn_allowed_device_types_objAdded property webauthn_allowed_device_types (array)
Items (string):
Added property webauthn_allowed_device_types_obj (array)
Items (object): > WebAuthnDeviceType Serializer
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/authenticator/validate/{stage_uuid}/Changed content type : application/json
Added property webauthn_allowed_device_types (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
Changed content type : application/json
New required properties:
webauthn_allowed_device_types_objAdded property webauthn_allowed_device_types (array)
Added property webauthn_allowed_device_types_obj (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/authenticator/validate/{stage_uuid}/Changed content type : application/json
Added property webauthn_allowed_device_types (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
Changed content type : application/json
New required properties:
webauthn_allowed_device_types_objAdded property webauthn_allowed_device_types (array)
Added property webauthn_allowed_device_types_obj (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/authenticator/webauthn/{stage_uuid}/GET /stages/authenticator/webauthn/{stage_uuid}/Changed response : 200 OK
Changed content type : application/json
New required properties:
device_type_restrictions_objAdded property device_type_restrictions (array)
Added property device_type_restrictions_obj (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/authenticator/webauthn/{stage_uuid}/Changed content type : application/json
Added property device_type_restrictions (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
Changed content type : application/json
New required properties:
device_type_restrictions_objAdded property device_type_restrictions (array)
Added property device_type_restrictions_obj (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/authenticator/webauthn/{stage_uuid}/Changed content type : application/json
Added property device_type_restrictions (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
Changed content type : application/json
New required properties:
device_type_restrictions_objAdded property device_type_restrictions (array)
Added property device_type_restrictions_obj (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/captcha/{stage_uuid}/GET /stages/captcha/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/captcha/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/captcha/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/consent/{stage_uuid}/GET /stages/consent/{stage_uuid}/Changed response : 200 OK
application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/consent/{stage_uuid}/Changed content type : application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/consent/{stage_uuid}/Changed content type : application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/deny/{stage_uuid}/GET /stages/deny/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/deny/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/deny/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/dummy/{stage_uuid}/GET /stages/dummy/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/dummy/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/dummy/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/email/{stage_uuid}/GET /stages/email/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/email/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/email/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/identification/{stage_uuid}/GET /stages/identification/{stage_uuid}/Changed response : 200 OK
application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/identification/{stage_uuid}/Changed content type : application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/identification/{stage_uuid}/Changed content type : application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/invitation/invitations/Changed response : 201 Created
application/json
Changed property flow_obj (object)
Flow Serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/invitation/invitations/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Invitation Serializer
Changed property flow_obj (object)
Flow Serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property authentication (string)
Required level of authentication and authorization to access a flow.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/invitation/stages/{stage_uuid}/GET /stages/invitation/stages/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/invitation/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/invitation/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/password/{stage_uuid}/GET /stages/password/{stage_uuid}/Changed response : 200 OK
application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/password/{stage_uuid}/Changed content type : application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/password/{stage_uuid}/Changed content type : application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/prompt/stages/{stage_uuid}/GET /stages/prompt/stages/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/prompt/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/prompt/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/user_delete/{stage_uuid}/GET /stages/user_delete/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/user_delete/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/user_delete/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/user_login/{stage_uuid}/GET /stages/user_login/{stage_uuid}/Changed response : 200 OK
application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/user_login/{stage_uuid}/Changed content type : application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/user_login/{stage_uuid}/Changed content type : application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/user_logout/{stage_uuid}/GET /stages/user_logout/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/user_logout/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/user_logout/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/user_write/{stage_uuid}/GET /stages/user_write/{stage_uuid}/Changed response : 200 OK
application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/user_write/{stage_uuid}/Changed content type : application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/user_write/{stage_uuid}/Changed content type : application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /core/transactional/applications/Changed content type : application/json
Changed property provider_model (string)
Changed property app (object)
Application Serializer
policy_engine_mode (string)Changed property provider (object)
Updated authentik_providers_oauth2.oauth2provider provider_model:
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Updated authentik_providers_proxy.proxyprovider provider_model:
mode (string)
Enable support for forwardAuth in traefik and nginx auth_request. Exclusive with internal_host.
Updated authentik_providers_saml.samlprovider provider_model:
Changed property sp_binding (string)
This determines how authentik sends the response back to the Service Provider.
Changed property digest_algorithm (string)
Changed property signature_algorithm (string)
Updated authentik_providers_ldap.ldapprovider provider_model:
search_mode (string)GET /core/user_consent/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserConsent Serializer
Changed property user (object)
User Serializer
type (string)Changed property application (object)
Application Serializer
policy_engine_mode (string)GET /events/notifications/Changed: severity in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Notification Serializer
Changed property severity (string)
Changed property event (object)
Event Serializer
action (string)POST /flows/bindings/Changed content type : application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed response : 201 Created
application/json
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property layout (string)
GET /flows/bindings/Changed: invalid_response_action in query
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed: policy_engine_mode in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > FlowStageBinding Serializer
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property layout (string)
GET /flows/executor/{flow_slug}/Changed response : 200 OK
Changed content type : application/json
Updated ak-stage-dummy component:
New required properties:
namename (string)Updated ak-provider-oauth2-device-code component:
Changed property type (string)
Changed property flow_info (object)
Contextual flow information for a challenge
layout (string)Updated ak-stage-prompt component:
Changed property fields (array)
Changed items (object): > Serializer for a single Prompt field
type (string)Updated ak-stage-identification component:
New required properties:
flow_designationAdded property flow_designation (string)
Enum values:
authenticationauthorizationinvalidationenrollmentunenrollmentrecoverystage_configurationPOST /flows/executor/{flow_slug}/Changed content type : application/json
Updated ak-source-oauth-apple component:
Changed response : 200 OK
Changed content type : application/json
Updated ak-stage-dummy component:
New required properties:
namename (string)Updated ak-provider-oauth2-device-code component:
Changed property type (string)
Changed property flow_info (object)
Contextual flow information for a challenge
layout (string)Updated ak-stage-prompt component:
Changed property fields (array)
Changed items (object): > Serializer for a single Prompt field
type (string)Updated ak-stage-identification component:
New required properties:
flow_designationflow_designation (string)GET /flows/inspector/{flow_slug}/Changed response : 200 OK
application/json
Changed property plans (array)
Changed items (object): > Serializer for an active FlowPlan
Changed property next_planned_stage (object)
FlowStageBinding Serializer
invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property current_stage (object)
FlowStageBinding Serializer
Changed property invalid_response_action (string)
Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
Changed property policy_engine_mode (string)
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property layout (string)
GET /oauth2/access_tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for BaseGrantModel and RefreshToken
Changed property provider (object)
OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed property user (object)
User Serializer
type (string)GET /oauth2/authorization_codes/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for BaseGrantModel and ExpiringBaseGrant
Changed property provider (object)
OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed property user (object)
User Serializer
type (string)GET /oauth2/refresh_tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for BaseGrantModel and RefreshToken
Changed property provider (object)
OAuth2Provider Serializer
Changed property client_type (string)
Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable
Changed property sub_mode (string)
Configure what data should be used as unique User Identifier. For most cases, the default should be fine.
Changed property issuer_mode (string)
Configure how the issuer field of the ID Token should be filled.
Changed property user (object)
User Serializer
type (string)GET /stages/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/authenticator/duo/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/authenticator/duo/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorDuoStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/authenticator/sms/Changed content type : application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/authenticator/sms/Changed: auth_type in query
Changed: provider in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorSMSStage Serializer
Changed property provider (string)
Changed property auth_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/authenticator/static/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/authenticator/static/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorStaticStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/authenticator/totp/Changed content type : application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/authenticator/totp/Changed: digits in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorTOTPStage Serializer
Changed property digits (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/authenticator/validate/Changed content type : application/json
Added property webauthn_allowed_device_types (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
Changed content type : application/json
New required properties:
webauthn_allowed_device_types_objAdded property webauthn_allowed_device_types (array)
Added property webauthn_allowed_device_types_obj (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/authenticator/validate/Changed: not_configured_action in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorValidateStage Serializer
New required properties:
webauthn_allowed_device_types_objAdded property webauthn_allowed_device_types (array)
Added property webauthn_allowed_device_types_obj (array)
Changed property webauthn_user_verification (string)
Enforce user verification for WebAuthn devices.
Changed property not_configured_action (string)
Changed property device_classes (array)
Device classes which can be used to authenticate
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/authenticator/webauthn/Changed content type : application/json
Added property device_type_restrictions (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
Changed content type : application/json
New required properties:
device_type_restrictions_objAdded property device_type_restrictions (array)
Added property device_type_restrictions_obj (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/authenticator/webauthn/Added: device_type_restrictions in query
Changed: authenticator_attachment in query
Changed: resident_key_requirement in query
Changed: user_verification in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorWebAuthnStage Serializer
New required properties:
device_type_restrictions_objAdded property device_type_restrictions (array)
Added property device_type_restrictions_obj (array)
Changed property authenticator_attachment (string)
Changed property user_verification (string)
Changed property resident_key_requirement (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/captcha/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/captcha/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > CaptchaStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/consent/Changed content type : application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/consent/Changed: mode in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ConsentStage Serializer
Changed property mode (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/deny/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/deny/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > DenyStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/dummy/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/dummy/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > DummyStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/email/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/email/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > EmailStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/identification/Changed content type : application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/identification/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > IdentificationStage Serializer
Changed property user_fields (array)
Fields of the user object to match against. (Hold shift to select multiple options)
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/invitation/stages/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/invitation/stages/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > InvitationStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/password/Changed content type : application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/password/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PasswordStage Serializer
Changed property backends (array)
Selection of backends to test the password against.
Changed items (string):
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
DELETE /stages/prompt/prompts/{prompt_uuid}/GET /stages/prompt/prompts/{prompt_uuid}/Changed response : 200 OK
application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PUT /stages/prompt/prompts/{prompt_uuid}/Changed content type : application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
PATCH /stages/prompt/prompts/{prompt_uuid}/Changed content type : application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/prompt/prompts/preview/Changed content type : application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 200 OK
application/json
Changed property type (string)
Changed property flow_info (object)
Contextual flow information for a challenge
layout (string)Changed property fields (array)
Changed items (object): > Serializer for a single Prompt field
type (string)POST /stages/prompt/stages/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/prompt/stages/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PromptStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/user_delete/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/user_delete/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserDeleteStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/user_login/Changed content type : application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/user_login/Changed: geoip_binding in query
Bind sessions created by this stage to the configured GeoIP location
Changed: network_binding in query
Bind sessions created by this stage to the configured network
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLoginStage Serializer
Changed property network_binding (string)
Bind sessions created by this stage to the configured network
Changed property geoip_binding (string)
Bind sessions created by this stage to the configured GeoIP location
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/user_logout/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/user_logout/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLogoutStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/user_write/Changed content type : application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/user_write/Changed: user_creation_mode in query
Changed: user_type in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserWriteStage Serializer
Changed property user_creation_mode (string)
Changed property user_type (string)
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
POST /stages/prompt/prompts/Changed content type : application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
Changed response : 201 Created
application/json
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)
GET /stages/prompt/prompts/Changed: type in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Prompt Serializer
Changed property type (string)
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed property designation (string)
Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
Changed property denied_action (string)
Configure what should happen when a flow denies access to a user.
Changed property policy_engine_mode (string)
Changed property layout (string)