website/docs/releases/2023/v2023.5.md
Deprecation of PostgreSQL 11 support
The next release of authentik will only support PostgreSQL 12 and newer. Upgrading can be done with https://github.com/tianon/docker-postgres-upgrade or by exporting the database and re-importing the database into a new PostgreSQL instance.
Removal of deprecated LDAP fields
This version removes the deprecated LDAP fields goauthentik.io/ldap/active and goauthentik.io/ldap/superuser.
Additionally, any custom fields based on user attributes will only be represented with their sanitized key, removing any slashes with dashes, and removing periods.
Renamed docker-compose environment variables
To better distinguish settings that configure authentik itself and settings that configure docker-compose, the environment variables AUTHENTIK_PORT_HTTP and AUTHENTIK_PORT_HTTPS have been renamed to COMPOSE_PORT_HTTP and COMPOSE_PORT_HTTPS respectively.
Backchannel providers
Backchannel providers can augment the functionality of applications by using additional protocols. The main provider of an application provides the SSO protocol that is used for logging into the application. Then, additional backchannel providers can be used for protocols such as SCIM and LDAP to provide directory syncing.
Access restrictions that are configured on an application apply to all of its backchannel providers.
Improved blueprint developer experience
The blueprint schema has been greatly expanded to make writing blueprints easier. Where previously only possible models would be autocompleted, with the new schema all model fields are suggested with their types and possible values.
Additionally, it is now possible to set Application and Source icons and Flow backgrounds via blueprints, by specifying their value as a URL.
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/2023.5/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.
Update your values to use the new images:
image:
repository: ghcr.io/goauthentik/server
tag: 2023.5.0
GET /crypto/certificatekeypairs/{kp_uuid}/Changed response : 200 OK
Changed content type : application/json
New required properties:
managedmanaged (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PUT /crypto/certificatekeypairs/{kp_uuid}/Changed content type : application/json
managed (string)
Objects which are managed by authentik. These objects are created and updated automatically. This is flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
Changed content type : application/json
New required properties:
managedmanaged (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PATCH /crypto/certificatekeypairs/{kp_uuid}/Changed content type : application/json
managed (string)
Objects which are managed by authentik. These objects are created and updated automatically. This is flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
Changed content type : application/json
New required properties:
managedmanaged (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
POST /crypto/certificatekeypairs/generate/Changed response : 200 OK
Changed content type : application/json
New required properties:
managedmanaged (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /policies/event_matcher/{policy_uuid}/Changed response : 200 OK
application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterprisePUT /policies/event_matcher/{policy_uuid}/Changed content type : application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterpriseChanged response : 200 OK
application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterprisePATCH /policies/event_matcher/{policy_uuid}/Changed content type : application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterpriseChanged response : 200 OK
application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterpriseGET /propertymappings/all/{pm_uuid}/Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/ldap/{pm_uuid}/Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PUT /propertymappings/ldap/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PATCH /propertymappings/ldap/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/saml/{pm_uuid}/Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PUT /propertymappings/saml/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PATCH /propertymappings/saml/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/scim/{pm_uuid}/Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PUT /propertymappings/scim/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PATCH /propertymappings/scim/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/scope/{pm_uuid}/Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PUT /propertymappings/scope/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PATCH /propertymappings/scope/{pm_uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /providers/all/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/oauth2/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PUT /providers/oauth2/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PATCH /providers/oauth2/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/proxy/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PUT /providers/proxy/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PATCH /providers/proxy/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/radius/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PUT /providers/radius/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PATCH /providers/radius/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /core/applications/{slug}/Changed response : 200 OK
Changed content type : application/json
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Items (integer):
Added property backchannel_providers_obj (array)
Items (object): > Provider Serializer
Property pk (integer)
Property name (string)
Property authentication_flow (string)
Flow used for authentication when the associated application is accessed by an un-authenticated user.
Property authorization_flow (string)
Flow used when authorizing this provider.
Property property_mappings (array)
Items (string):
Property component (string)
Get object component so that we know how to edit the object
Property assigned_application_slug (string)
Internal application name, used in URLs.
Property assigned_application_name (string)
Application's display Name.
Property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Property assigned_backchannel_application_name (string)
Application's display Name.
Property verbose_name (string)
Return object's verbose_name
Property verbose_name_plural (string)
Return object's plural verbose_name
Property meta_model_name (string)
Return internal model name
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /core/applications/{slug}/Changed content type : application/json
Added property backchannel_providers (array)
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
Changed content type : application/json
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Added property backchannel_providers_obj (array)
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /core/applications/{slug}/Changed content type : application/json
Added property backchannel_providers (array)
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
Changed content type : application/json
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Added property backchannel_providers_obj (array)
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /core/tokens/{identifier}/Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PUT /core/tokens/{identifier}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
PATCH /core/tokens/{identifier}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
POST /crypto/certificatekeypairs/Changed content type : application/json
managed (string)
Objects which are managed by authentik. These objects are created and updated automatically. This is flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
Changed content type : application/json
New required properties:
managedmanaged (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /crypto/certificatekeypairs/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > CertificateKeyPair Serializer
New required properties:
managedmanaged (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /flows/instances/{slug}/Changed response : 200 OK
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /flows/instances/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /flows/instances/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /outposts/instances/{uuid}/Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property providers_obj (array)
Changed items (object): > Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PUT /outposts/instances/{uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property providers_obj (array)
Changed items (object): > Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PATCH /outposts/instances/{uuid}/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property providers_obj (array)
Changed items (object): > Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /outposts/ldap/{id}/Changed response : 200 OK
application/json
application_slug (string)
Prioritise backchannel slug over direct application slug
POST /policies/event_matcher/Changed content type : application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterpriseChanged response : 201 Created
application/json
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterpriseGET /policies/event_matcher/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Event Matcher Policy Serializer
Changed property app (string)
authentik.admin- authentik Adminauthentik.api- authentik APIauthentik.crypto- authentik Cryptoauthentik.events- authentik Eventsauthentik.flows- authentik Flowsauthentik.lib- authentik libauthentik.outposts- authentik Outpostauthentik.policies.dummy- authentik Policies.Dummyauthentik.policies.event_matcher- authentik Policies.Event Matcherauthentik.policies.expiry- authentik Policies.Expiryauthentik.policies.expression- authentik Policies.Expressionauthentik.policies.password- authentik Policies.Passwordauthentik.policies.reputation- authentik Policies.Reputationauthentik.policies- authentik Policiesauthentik.providers.ldap- authentik Providers.LDAPauthentik.providers.oauth2- authentik Providers.OAuth2authentik.providers.proxy- authentik Providers.Proxyauthentik.providers.radius- authentik Providers.Radiusauthentik.providers.saml- authentik Providers.SAMLauthentik.providers.scim- authentik Providers.SCIMauthentik.recovery- authentik Recoveryauthentik.sources.ldap- authentik Sources.LDAPauthentik.sources.oauth- authentik Sources.OAuthauthentik.sources.plex- authentik Sources.Plexauthentik.sources.saml- authentik Sources.SAMLauthentik.stages.authenticator_duo- authentik Stages.Authenticator.Duoauthentik.stages.authenticator_sms- authentik Stages.Authenticator.SMSauthentik.stages.authenticator_static- authentik Stages.Authenticator.Staticauthentik.stages.authenticator_totp- authentik Stages.Authenticator.TOTPauthentik.stages.authenticator_validate- authentik Stages.Authenticator.Validateauthentik.stages.authenticator_webauthn- authentik Stages.Authenticator.WebAuthnauthentik.stages.captcha- authentik Stages.Captchaauthentik.stages.consent- authentik Stages.Consentauthentik.stages.deny- authentik Stages.Denyauthentik.stages.dummy- authentik Stages.Dummyauthentik.stages.email- authentik Stages.Emailauthentik.stages.identification- authentik Stages.Identificationauthentik.stages.invitation- authentik Stages.User Invitationauthentik.stages.password- authentik Stages.Passwordauthentik.stages.prompt- authentik Stages.Promptauthentik.stages.user_delete- authentik Stages.User Deleteauthentik.stages.user_login- authentik Stages.User Loginauthentik.stages.user_logout- authentik Stages.User Logoutauthentik.stages.user_write- authentik Stages.User Writeauthentik.tenants- authentik Tenantsauthentik.blueprints- authentik Blueprintsauthentik.core- authentik Coreauthentik.enterprise- authentik Enterprise
Added enum value:
authentik.enterpriseGET /propertymappings/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PropertyMapping Serializer
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
POST /propertymappings/ldap/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAP PropertyMapping Serializer
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
POST /propertymappings/saml/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/saml/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLPropertyMapping Serializer
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
POST /propertymappings/scim/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/scim/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SCIMMapping Serializer
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
POST /propertymappings/scope/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /propertymappings/scope/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ScopeMapping Serializer
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /providers/all/Added: backchannel_only in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/ldap/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PUT /providers/ldap/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PATCH /providers/ldap/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
POST /providers/oauth2/Changed response : 201 Created
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/oauth2/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth2Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
POST /providers/proxy/Changed response : 201 Created
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/proxy/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ProxyProvider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
POST /providers/radius/Changed response : 201 Created
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/radius/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > RadiusProvider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/saml/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PUT /providers/saml/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
PATCH /providers/saml/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /root/config/Changed response : 200 OK
application/json
Changed property capabilities (array)
Changed items (string): > _ can_save_media - Can Save Media > _ can_geo_ip - Can Geo Ip > _ can_impersonate - Can Impersonate > _ can_debug - Can Debug > * is_enterprise - Is Enterprise
Added enum value:
is_enterpriseGET /sources/all/{slug}/Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/ldap/{slug}/Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/ldap/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/ldap/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/oauth/{slug}/Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonPUT /sources/oauth/{slug}/Changed content type : application/json
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonChanged response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonPATCH /sources/oauth/{slug}/Changed content type : application/json
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonChanged response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonGET /sources/plex/{slug}/Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/plex/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/plex/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/saml/{slug}/Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/saml/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/saml/{slug}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/user_connections/oauth/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/user_connections/oauth/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/user_connections/oauth/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/user_connections/plex/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/user_connections/plex/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/user_connections/plex/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/user_connections/saml/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /sources/user_connections/saml/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /sources/user_connections/saml/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/invitation/invitations/{invite_uuid}/Changed response : 200 OK
application/json
Changed property flow_obj (object)
Flow Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/invitation/invitations/{invite_uuid}/Changed response : 200 OK
application/json
Changed property flow_obj (object)
Flow Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/invitation/invitations/{invite_uuid}/Changed response : 200 OK
application/json
Changed property flow_obj (object)
Flow Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /core/applications/Changed content type : application/json
Added property backchannel_providers (array)
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
Changed content type : application/json
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Added property backchannel_providers_obj (array)
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /core/applications/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Application Serializer
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Added property backchannel_providers_obj (array)
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /core/tokens/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /core/tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Token Serializer
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
GET /core/user_consent/{id}/Changed response : 200 OK
application/json
Changed property application (object)
Application Serializer
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Added property backchannel_providers_obj (array)
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /flows/bindings/{fsb_uuid}/Changed response : 200 OK
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /flows/bindings/{fsb_uuid}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /flows/bindings/{fsb_uuid}/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /flows/instances/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /flows/instances/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Flow Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /oauth2/access_tokens/{id}/Changed response : 200 OK
application/json
Changed property provider (object)
OAuth2Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /oauth2/authorization_codes/{id}/Changed response : 200 OK
application/json
Changed property provider (object)
OAuth2Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /oauth2/refresh_tokens/{id}/Changed response : 200 OK
application/json
Changed property provider (object)
OAuth2Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
POST /outposts/instances/Changed content type : application/json
managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed response : 201 Created
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property providers_obj (array)
Changed items (object): > Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /outposts/instances/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Outpost Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property providers_obj (array)
Changed items (object): > Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /outposts/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAPProvider Serializer
application_slug (string)
Prioritise backchannel slug over direct application slug
POST /providers/ldap/Changed response : 201 Created
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAPProvider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
POST /providers/saml/Changed response : 201 Created
Changed content type : application/json
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /providers/saml/Added: backchannel_application in query
Added: is_backchannel in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLProvider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
GET /sources/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /sources/ldap/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAP Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /sources/oauth/Changed content type : application/json
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonChanged response : 201 Created
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonGET /sources/oauth/Changed: policy_engine_mode in query
all- all, all policies must passany- any, any policy must passall- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed property provider_type (string)
apple- Appleazuread- Azure ADdiscord- Discordgithub- GitHubmailcow- Mailcowopenidconnect- OpenID Connectokta- Oktapatreon- Patreontwitch- Twitch
Added enum value:
patreonPOST /sources/plex/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/plex/Changed: policy_engine_mode in query
all- all, all policies must passany- any, any policy must passall- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Plex Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /sources/saml/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /sources/saml/Changed: policy_engine_mode in query
all- all, all policies must passany- any, any policy must passall- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLSource Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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 managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /sources/user_connections/oauth/Changed response : 201 Created
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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 managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /sources/user_connections/plex/Changed response : 201 Created
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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 managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /sources/user_connections/saml/Changed response : 201 Created
application/json
Changed property source (object)
Source Serializer
Changed property managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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 managed (string)
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/all/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/duo/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/authenticator/duo/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/authenticator/duo/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/sms/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/authenticator/sms/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/authenticator/sms/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/static/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/authenticator/static/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/authenticator/static/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/totp/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/authenticator/totp/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/authenticator/totp/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/validate/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/authenticator/validate/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/authenticator/validate/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/webauthn/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/authenticator/webauthn/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/authenticator/webauthn/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/captcha/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/captcha/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/captcha/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/consent/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/consent/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/consent/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/deny/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/deny/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/deny/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/dummy/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/dummy/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/dummy/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/email/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/email/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/email/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/identification/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/identification/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/identification/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/invitation/invitations/Changed response : 201 Created
application/json
Changed property flow_obj (object)
Flow Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/invitation/stages/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/invitation/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/invitation/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/password/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/password/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/password/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/prompt/stages/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/prompt/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/prompt/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/user_delete/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/user_delete/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/user_delete/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/user_login/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/user_login/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/user_login/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/user_logout/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/user_logout/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/user_logout/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/user_write/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/user_write/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/user_write/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /core/user_consent/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserConsent Serializer
Changed property application (object)
Application Serializer
New required properties:
backchannel_providers_objAdded property backchannel_providers (array)
Added property backchannel_providers_obj (array)
Changed property provider_obj (object)
Provider Serializer
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
Changed property policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /flows/bindings/Changed content type : application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /flows/bindings/Changed: policy_engine_mode in query
all- all, all policies must passany- any, any policy must passall- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > FlowStageBinding Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /flows/executor/{flow_slug}/Changed response : 200 OK
Changed content type : application/json
Updated ak-stage-prompt component:
Changed property fields (array)
Changed items (object): > Serializer for a single Prompt field
New required properties:
initial_valueinitial_value (string)POST /flows/executor/{flow_slug}/Changed response : 200 OK
Changed content type : application/json
Updated ak-stage-prompt component:
Changed property fields (array)
Changed items (object): > Serializer for a single Prompt field
New required properties:
initial_valueinitial_value (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 current_stage (object)
FlowStageBinding Serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
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
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
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
New required properties:
assigned_backchannel_application_nameassigned_backchannel_application_slugAdded property assigned_backchannel_application_slug (string)
Internal application name, used in URLs.
Added property assigned_backchannel_application_name (string)
Application's display Name.
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/authenticator/duo/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/authenticator/sms/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/sms/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorSMSStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/authenticator/static/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/authenticator/totp/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/totp/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorTOTPStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/authenticator/validate/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/validate/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorValidateStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/authenticator/webauthn/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/authenticator/webauthn/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticateWebAuthnStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/captcha/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/consent/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/consent/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ConsentStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/deny/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/dummy/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/email/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/identification/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/identification/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > IdentificationStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/invitation/stages/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/password/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/password/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PasswordStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/prompt/prompts/{prompt_uuid}/Changed response : 200 OK
application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PUT /stages/prompt/prompts/{prompt_uuid}/Changed content type : application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
PATCH /stages/prompt/prompts/{prompt_uuid}/Changed content type : application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/prompt/prompts/preview/Changed content type : application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 200 OK
application/json
Changed property fields (array)
Changed items (object): > Serializer for a single Prompt field
New required properties:
initial_valueinitial_value (string)POST /stages/prompt/stages/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/user_delete/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/user_login/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/user_login/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLoginStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/user_logout/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
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
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/user_write/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/user_write/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserWriteStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
POST /stages/prompt/prompts/Changed content type : application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
Changed response : 201 Created
application/json
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass
GET /stages/prompt/prompts/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Prompt Serializer
Added property initial_value (string)
Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
Added property initial_value_expression (boolean)
Changed property placeholder (string)
Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
policy_engine_mode (string)
all- all, all policies must passany- any, any policy must pass