From fb8c4b97f4ce128de3b70169ef59fdd064704e2d Mon Sep 17 00:00:00 2001 From: Jens L Date: Tue, 4 Jul 2023 14:25:08 +0200 Subject: [PATCH] website: update navbar, update 2023.6 changelog (#6136) * website: update navbar, update 2023.6 changelog Signed-off-by: Jens Langhammer * fix Signed-off-by: Jens Langhammer --------- Signed-off-by: Jens Langhammer --- website/docs/releases/2023/v2023.6.md | 6822 +------------------------ website/docusaurus.config.js | 12 +- website/docusaurus.docs-only.js | 7 +- 3 files changed, 135 insertions(+), 6706 deletions(-) diff --git a/website/docs/releases/2023/v2023.6.md b/website/docs/releases/2023/v2023.6.md index fb44858ca..bf05efa16 100644 --- a/website/docs/releases/2023/v2023.6.md +++ b/website/docs/releases/2023/v2023.6.md @@ -93,80 +93,6 @@ image: --- -##### `GET` /crypto/certificatekeypairs/{kp_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `managed` - - * 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. - -##### `PUT` /crypto/certificatekeypairs/{kp_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Deleted property `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `managed` - - * 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. - -##### `PATCH` /crypto/certificatekeypairs/{kp_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Deleted property `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `managed` - - * 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. - -##### `POST` /crypto/certificatekeypairs/generate/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `managed` - - * 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. - ##### `GET` /policies/event_matcher/{policy_uuid}/ ###### Return Type: @@ -323,61 +249,6 @@ Changed response : **200 OK** - `authentik_core.application` - `authentik_core.token` - - Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - ##### `PUT` /policies/event_matcher/{policy_uuid}/ ###### Request: @@ -385,7 +256,6 @@ Changed response : **200 OK** Changed content type : `application/json` - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -459,61 +329,6 @@ Changed content type : `application/json` > - `authentik_core.application` - Application > - `authentik_core.token` - Token -- Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - ###### Return Type: Changed response : **200 OK** @@ -521,7 +336,6 @@ Changed response : **200 OK** - Changed content type : `application/json` - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -595,61 +409,6 @@ Changed response : **200 OK** > - `authentik_core.application` - Application > - `authentik_core.token` - Token - - Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - ##### `PATCH` /policies/event_matcher/{policy_uuid}/ ###### Request: @@ -657,7 +416,6 @@ Changed response : **200 OK** Changed content type : `application/json` - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -731,61 +489,6 @@ Changed content type : `application/json` > - `authentik_core.application` - Application > - `authentik_core.token` - Token -- Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - ###### Return Type: Changed response : **200 OK** @@ -793,7 +496,6 @@ Changed response : **200 OK** - Changed content type : `application/json` - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -867,1137 +569,6 @@ Changed response : **200 OK** > - `authentik_core.application` - Application > - `authentik_core.token` - Token - - Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - -##### `GET` /propertymappings/all/{pm_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `GET` /propertymappings/ldap/{pm_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PUT` /propertymappings/ldap/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PATCH` /propertymappings/ldap/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `GET` /propertymappings/saml/{pm_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PUT` /propertymappings/saml/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PATCH` /propertymappings/saml/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `GET` /propertymappings/scim/{pm_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PUT` /propertymappings/scim/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PATCH` /propertymappings/scim/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `GET` /propertymappings/scope/{pm_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PUT` /propertymappings/scope/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `PATCH` /propertymappings/scope/{pm_uuid}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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. - -##### `GET` /providers/all/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -##### `PUT` /providers/oauth2/{id}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -##### `PATCH` /providers/oauth2/{id}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -##### `GET` /providers/proxy/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - `outpost_set` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `outpost_set` (array) - - Items (string): - -##### `PUT` /providers/radius/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - `outpost_set` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `outpost_set` (array) - -##### `PATCH` /providers/radius/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - `outpost_set` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `outpost_set` (array) - -##### `GET` /providers/scim/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - New optional properties: - - - `assigned_application_name` - - `assigned_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Deleted property `assigned_application_slug` (string) - - > Internal application name, used in URLs. - - * Deleted property `assigned_application_name` (string) - > Application's display Name. - -##### `PUT` /providers/scim/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - New optional properties: - - - `assigned_application_name` - - `assigned_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Deleted property `assigned_application_slug` (string) - - > Internal application name, used in URLs. - - * Deleted property `assigned_application_name` (string) - > Application's display Name. - -##### `PATCH` /providers/scim/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - New optional properties: - - - `assigned_application_name` - - `assigned_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Deleted property `assigned_application_slug` (string) - - > Internal application name, used in URLs. - - * Deleted property `assigned_application_name` (string) - > Application's display Name. - -##### `GET` /core/applications/{slug}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `backchannel_providers_obj` - - * Added 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_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `PUT` /core/applications/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Added property `backchannel_providers` (array) - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `backchannel_providers_obj` - - * Added property `backchannel_providers` (array) - - * Added property `backchannel_providers_obj` (array) - - * Changed property `provider_obj` (object) - - > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `PATCH` /core/applications/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Added property `backchannel_providers` (array) - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `backchannel_providers_obj` - - * Added property `backchannel_providers` (array) - - * Added property `backchannel_providers_obj` (array) - - * Changed property `provider_obj` (object) - - > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `GET` /core/tokens/{identifier}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `PUT` /core/tokens/{identifier}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `PATCH` /core/tokens/{identifier}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /core/users/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New optional properties: - - - `groups` - -##### `PUT` /core/users/{id}/ - -###### Request: - -Changed content type : `application/json` - -New optional properties: - -- `groups` - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New optional properties: - - - `groups` - -##### `PATCH` /core/users/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New optional properties: - - - `groups` - -##### `POST` /crypto/certificatekeypairs/ - -###### Request: - -Changed content type : `application/json` - -- Deleted property `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `managed` - - * 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. - -##### `GET` /crypto/certificatekeypairs/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > CertificateKeyPair Serializer - - New required properties: - - - `managed` - - * 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. - -##### `GET` /flows/instances/{slug}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /flows/instances/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /flows/instances/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /outposts/instances/{uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ ###### Return Type: @@ -2010,10 +581,6 @@ Changed response : **200 OK** > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - - Changed property `application_slug` (string) - - > Prioritise backchannel slug over direct application slug - - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber @@ -2021,54 +588,6 @@ Changed response : **200 OK** - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber -##### `GET` /policies/bindings/{policy_binding_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `PUT` /policies/bindings/{policy_binding_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `PATCH` /policies/bindings/{policy_binding_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - ##### `POST` /policies/event_matcher/ ###### Request: @@ -2076,7 +595,6 @@ Changed response : **200 OK** Changed content type : `application/json` - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -2150,61 +668,6 @@ Changed content type : `application/json` > - `authentik_core.application` - Application > - `authentik_core.token` - Token -- Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - ###### Return Type: Changed response : **201 Created** @@ -2212,7 +675,6 @@ Changed response : **201 Created** - Changed content type : `application/json` - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -2286,61 +748,6 @@ Changed response : **201 Created** > - `authentik_core.application` - Application > - `authentik_core.token` - Token - - Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - ##### `GET` /policies/event_matcher/ ###### Parameters: @@ -2358,7 +765,6 @@ Changed response : **200 OK** Changed items (object): > Event Matcher Policy Serializer - Added property `model` (object) - > Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched. > > - `authentik_crypto.certificatekeypair` - Certificate-Key Pair @@ -2432,236 +838,6 @@ Changed response : **200 OK** > - `authentik_core.application` - Application > - `authentik_core.token` - Token - - Changed property `app` (string) - - > - `authentik.admin` - authentik Admin - > - `authentik.api` - authentik API - > - `authentik.crypto` - authentik Crypto - > - `authentik.events` - authentik Events - > - `authentik.flows` - authentik Flows - > - `authentik.lib` - authentik lib - > - `authentik.outposts` - authentik Outpost - > - `authentik.policies.dummy` - authentik Policies.Dummy - > - `authentik.policies.event_matcher` - authentik Policies.Event Matcher - > - `authentik.policies.expiry` - authentik Policies.Expiry - > - `authentik.policies.expression` - authentik Policies.Expression - > - `authentik.policies.password` - authentik Policies.Password - > - `authentik.policies.reputation` - authentik Policies.Reputation - > - `authentik.policies` - authentik Policies - > - `authentik.providers.ldap` - authentik Providers.LDAP - > - `authentik.providers.oauth2` - authentik Providers.OAuth2 - > - `authentik.providers.proxy` - authentik Providers.Proxy - > - `authentik.providers.radius` - authentik Providers.Radius - > - `authentik.providers.saml` - authentik Providers.SAML - > - `authentik.providers.scim` - authentik Providers.SCIM - > - `authentik.recovery` - authentik Recovery - > - `authentik.sources.ldap` - authentik Sources.LDAP - > - `authentik.sources.oauth` - authentik Sources.OAuth - > - `authentik.sources.plex` - authentik Sources.Plex - > - `authentik.sources.saml` - authentik Sources.SAML - > - `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo - > - `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS - > - `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static - > - `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP - > - `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate - > - `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn - > - `authentik.stages.captcha` - authentik Stages.Captcha - > - `authentik.stages.consent` - authentik Stages.Consent - > - `authentik.stages.deny` - authentik Stages.Deny - > - `authentik.stages.dummy` - authentik Stages.Dummy - > - `authentik.stages.email` - authentik Stages.Email - > - `authentik.stages.identification` - authentik Stages.Identification - > - `authentik.stages.invitation` - authentik Stages.User Invitation - > - `authentik.stages.password` - authentik Stages.Password - > - `authentik.stages.prompt` - authentik Stages.Prompt - > - `authentik.stages.user_delete` - authentik Stages.User Delete - > - `authentik.stages.user_login` - authentik Stages.User Login - > - `authentik.stages.user_logout` - authentik Stages.User Logout - > - `authentik.stages.user_write` - authentik Stages.User Write - > - `authentik.tenants` - authentik Tenants - > - `authentik.blueprints` - authentik Blueprints - > - `authentik.core` - authentik Core - > - `authentik.enterprise` - authentik Enterprise - - Added enum value: - - - `authentik.enterprise` - -##### `GET` /propertymappings/all/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > PropertyMapping 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. - -##### `POST` /propertymappings/ldap/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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. - -##### `GET` /propertymappings/ldap/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > LDAP PropertyMapping 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. - -##### `POST` /propertymappings/saml/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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. - -##### `GET` /propertymappings/saml/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > SAMLPropertyMapping 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. - -##### `POST` /propertymappings/scim/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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. - -##### `GET` /propertymappings/scim/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > SCIMMapping 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. - -##### `POST` /propertymappings/scope/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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. - -##### `GET` /propertymappings/scope/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > ScopeMapping 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. - -##### `GET` /providers/all/ - -###### Parameters: - -Added: `backchannel_only` in `query` - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ ###### Return Type: @@ -2670,28 +846,15 @@ Changed response : **200 OK** - Changed content type : `application/json` - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `mfa_support` (boolean) + - Added property `mfa_support` (boolean) > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - * Changed property `uid_start_number` (integer) + - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber - * Changed property `gid_start_number` (integer) + - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber ##### `PUT` /providers/ldap/{id}/ @@ -2717,28 +880,15 @@ Changed response : **200 OK** - Changed content type : `application/json` - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `mfa_support` (boolean) + - Added property `mfa_support` (boolean) > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - * Changed property `uid_start_number` (integer) + - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber - * Changed property `gid_start_number` (integer) + - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber ##### `PATCH` /providers/ldap/{id}/ @@ -2764,390 +914,17 @@ Changed response : **200 OK** - Changed content type : `application/json` - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `mfa_support` (boolean) + - Added property `mfa_support` (boolean) > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - * Changed property `uid_start_number` (integer) + - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber - * Changed property `gid_start_number` (integer) + - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber -##### `POST` /providers/oauth2/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -##### `GET` /providers/oauth2/ - -###### Parameters: - -Changed: `sub_mode` in `query` - -> Configure what data should be used as unique User Identifier. For most cases, the default should be fine. -> -> - `hashed_user_id` - Based on the Hashed User ID -> - `user_id` - Based on user ID -> - `user_uuid` - Based on user UUID -> - `user_username` - Based on the username -> - `user_email` - Based on the User's Email. This is recommended over the UPN method. -> - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > OAuth2Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - -##### `POST` /providers/proxy/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > ProxyProvider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - `outpost_set` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `outpost_set` (array) - -##### `GET` /providers/radius/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > RadiusProvider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - `outpost_set` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `outpost_set` (array) - -##### `GET` /providers/saml/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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/scim/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - New optional properties: - - - `assigned_application_name` - - `assigned_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Deleted property `assigned_application_slug` (string) - - > Internal application name, used in URLs. - - * Deleted property `assigned_application_name` (string) - > Application's display Name. - -##### `GET` /providers/scim/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > SCIMProvider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - New optional properties: - - - `assigned_application_name` - - `assigned_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Deleted property `assigned_application_slug` (string) - - > Internal application name, used in URLs. - - * Deleted property `assigned_application_name` (string) - > Application's display Name. - -##### `GET` /root/config/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_enterprise` - -##### `GET` /sources/all/{slug}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - ##### `GET` /sources/ldap/{slug}/ ###### Return Type: @@ -3162,14 +939,6 @@ Changed response : **200 OK** - Added property `sni` (boolean) - - 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 pass - > - `any` - any, any policy must pass - ##### `PUT` /sources/ldap/{slug}/ ###### Request: @@ -3182,10 +951,6 @@ Changed content type : `application/json` - Added property `sni` (boolean) -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ###### Return Type: Changed response : **200 OK** @@ -3198,14 +963,6 @@ Changed response : **200 OK** - Added property `sni` (boolean) - - 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 pass - > - `any` - any, any policy must pass - ##### `PATCH` /sources/ldap/{slug}/ ###### Request: @@ -3218,10 +975,6 @@ Changed content type : `application/json` - Added property `sni` (boolean) -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ###### Return Type: Changed response : **200 OK** @@ -3234,247 +987,6 @@ Changed response : **200 OK** - Added property `sni` (boolean) - - 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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/oauth/{slug}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - - - Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -##### `PUT` /sources/oauth/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -- Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - - - Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -##### `PATCH` /sources/oauth/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -- Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - - - Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -##### `GET` /sources/plex/{slug}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PUT` /sources/plex/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PATCH` /sources/plex/{slug}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - ##### `GET` /sources/saml/{slug}/ ###### Return Type: @@ -3487,18 +999,9 @@ Changed response : **200 OK** > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - - 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 `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ##### `PUT` /sources/saml/{slug}/ ###### Request: @@ -3510,13 +1013,8 @@ Changed content type : `application/json` > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - Changed property `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ###### Return Type: Changed response : **200 OK** @@ -3527,18 +1025,9 @@ Changed response : **200 OK** > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - - 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 `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ##### `PATCH` /sources/saml/{slug}/ ###### Request: @@ -3550,13 +1039,8 @@ Changed content type : `application/json` > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - Changed property `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ###### Return Type: Changed response : **200 OK** @@ -3567,819 +1051,30 @@ Changed response : **200 OK** > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - - 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 `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/all/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PUT` /sources/user_connections/all/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PATCH` /sources/user_connections/all/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/oauth/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PUT` /sources/user_connections/oauth/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PATCH` /sources/user_connections/oauth/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/plex/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PUT` /sources/user_connections/plex/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PATCH` /sources/user_connections/plex/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/saml/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PUT` /sources/user_connections/saml/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `PATCH` /sources/user_connections/saml/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /stages/invitation/invitations/{invite_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_obj` (object) - - > Flow Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/invitation/invitations/{invite_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_obj` (object) - - > Flow Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/invitation/invitations/{invite_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_obj` (object) - - > Flow Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /core/applications/ - -###### Request: - -Changed content type : `application/json` - -- Added property `backchannel_providers` (array) - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `backchannel_providers_obj` - - * Added property `backchannel_providers` (array) - - * Added property `backchannel_providers_obj` (array) - - * Changed property `provider_obj` (object) - - > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `GET` /core/applications/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > Application Serializer - - New required properties: - - - `backchannel_providers_obj` - - * Added property `backchannel_providers` (array) - - * Added property `backchannel_providers_obj` (array) - - * Changed property `provider_obj` (object) - - > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `POST` /core/tokens/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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 `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - ##### `GET` /core/tokens/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `intent` in `query` -- Changed content type : `application/json` +> - `verification` - Intent Verification +> - `api` - Intent Api +> - `recovery` - Intent Recovery +> - `app_password` - Intent App Password - - Changed property `results` (array) +##### `GET` /events/transports/ - Changed items (object): > Token Serializer +###### Parameters: - - Changed property `managed` (string) +Changed: `mode` in `query` - > 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 `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /core/user_consent/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - - - Changed property `application` (object) - - > Application Serializer - - New required properties: - - - `backchannel_providers_obj` - - * Added property `backchannel_providers` (array) - - * Added property `backchannel_providers_obj` (array) - - * Changed property `provider_obj` (object) - - > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `POST` /core/users/ - -###### Request: - -Changed content type : `application/json` - -New optional properties: - -- `groups` - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New optional properties: - - - `groups` - -##### `GET` /core/users/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /flows/bindings/{fsb_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /flows/bindings/{fsb_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /flows/bindings/{fsb_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /flows/instances/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /flows/instances/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > Flow Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /oauth2/access_tokens/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `provider` (object) - - > OAuth2Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /oauth2/authorization_codes/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `provider` (object) - - > OAuth2Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /oauth2/refresh_tokens/{id}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `provider` (object) - - > OAuth2Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `POST` /outposts/instances/ - -###### Request: - -Changed content type : `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. - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - > Application's display Name. +> - `local` - authentik inbuilt notifications +> - `webhook` - Generic Webhook +> - `webhook_slack` - Slack Webhook (Slack/Discord) +> - `email` - Email ##### `GET` /outposts/ldap/ @@ -4397,10 +1092,6 @@ Changed response : **200 OK** > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - - Changed property `application_slug` (string) - - > Prioritise backchannel slug over direct application slug - - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber @@ -4408,42 +1099,6 @@ Changed response : **200 OK** - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber -##### `POST` /policies/bindings/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /policies/bindings/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > PolicyBinding Serializer - - - Changed property `user_obj` (object) - - > User Serializer - - New optional properties: - - - `groups` - ##### `POST` /providers/ldap/ ###### Request: @@ -4467,28 +1122,15 @@ Changed response : **201 Created** - Changed content type : `application/json` - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `mfa_support` (boolean) + - Added property `mfa_support` (boolean) > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - * Changed property `uid_start_number` (integer) + - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber - * Changed property `gid_start_number` (integer) + - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber ##### `GET` /providers/ldap/ @@ -4503,99 +1145,35 @@ Changed response : **200 OK** Changed items (object): > LDAPProvider Serializer - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added property `assigned_backchannel_application_slug` (string) - - > Internal application name, used in URLs. - - * Added property `assigned_backchannel_application_name` (string) - - > Application's display Name. - - * Added property `mfa_support` (boolean) + - Added property `mfa_support` (boolean) > When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon. - * Changed property `uid_start_number` (integer) + - Changed property `uid_start_number` (integer) > The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber - * Changed property `gid_start_number` (integer) + - Changed property `gid_start_number` (integer) > The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber -##### `POST` /providers/saml/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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/ ###### Parameters: -Added: `backchannel_application` in `query` +Changed: `digest_algorithm` in `query` -Added: `is_backchannel` in `query` +> - `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1 +> - `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256 +> - `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384 +> - `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512 -###### Return Type: +Changed: `signature_algorithm` in `query` -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > SAMLProvider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass +> - `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1 +> - `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256 +> - `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384 +> - `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512 +> - `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1 ##### `POST` /sources/ldap/ @@ -4609,10 +1187,6 @@ Changed content type : `application/json` - Added property `sni` (boolean) -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ###### Return Type: Changed response : **201 Created** @@ -4625,14 +1199,6 @@ Changed response : **201 Created** - Added property `sni` (boolean) - - 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 pass - > - `any` - any, any policy must pass - ##### `GET` /sources/ldap/ ###### Parameters: @@ -4657,80 +1223,6 @@ Changed response : **200 OK** - Added property `sni` (boolean) - - 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 pass - > - `any` - any, any policy must pass - -##### `POST` /sources/oauth/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -- Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - - - Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - ##### `GET` /sources/oauth/ ###### Parameters: @@ -4739,72 +1231,6 @@ Changed: `policy_engine_mode` in `query` > - `all` - all, all policies must pass > - `any` - any, any policy must pass -> -> - `all` - all, all policies must pass -> - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - - - Changed property `provider_type` (string) - - > - `apple` - Apple - > - `azuread` - Azure AD - > - `discord` - Discord - > - `facebook` - Facebook - > - `github` - GitHub - > - `google` - Google - > - `mailcow` - Mailcow - > - `openidconnect` - OpenID Connect - > - `okta` - Okta - > - `patreon` - Patreon - > - `reddit` - Reddit - > - `twitch` - Twitch - > - `twitter` - Twitter - - Added enum value: - - - `patreon` - -##### `POST` /sources/plex/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass ##### `GET` /sources/plex/ @@ -4814,27 +1240,6 @@ Changed: `policy_engine_mode` in `query` > - `all` - all, all policies must pass > - `any` - any, any policy must pass -> -> - `all` - all, all policies must pass -> - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass ##### `POST` /sources/saml/ @@ -4847,13 +1252,8 @@ Changed content type : `application/json` > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - Changed property `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ###### Return Type: Changed response : **201 Created** @@ -4864,31 +1264,40 @@ Changed response : **201 Created** > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - - 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 `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - ##### `GET` /sources/saml/ ###### Parameters: Added: `verification_kp` in `query` +Changed: `binding_type` in `query` + +> - `REDIRECT` - Redirect Binding +> - `POST` - POST Binding +> - `POST_AUTO` - POST Binding with auto-confirmation + +Changed: `digest_algorithm` in `query` + +> - `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1 +> - `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256 +> - `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384 +> - `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512 + Changed: `policy_engine_mode` in `query` > - `all` - all, all policies must pass > - `any` - any, any policy must pass -> -> - `all` - all, all policies must pass -> - `any` - any, any policy must pass + +Changed: `signature_algorithm` in `query` + +> - `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1 +> - `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256 +> - `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384 +> - `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512 +> - `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1 ###### Return Type: @@ -4904,1665 +1313,18 @@ Changed response : **200 OK** > When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default. - - 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 `signing_kp` (string) - > Keypair used to sign outgoing Responses going to the Identity Provider. - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +##### `GET` /events/notifications/ -##### `GET` /sources/user_connections/all/ +###### Parameters: -###### Return Type: +Changed: `severity` in `query` -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `POST` /sources/user_connections/oauth/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/oauth/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `POST` /sources/user_connections/plex/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/plex/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `POST` /sources/user_connections/saml/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /sources/user_connections/saml/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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 pass - > - `any` - any, any policy must pass - -##### `GET` /stages/all/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/duo/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/authenticator/duo/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/authenticator/duo/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/sms/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/authenticator/sms/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/authenticator/sms/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/static/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/authenticator/static/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/authenticator/static/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/totp/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/authenticator/totp/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/authenticator/totp/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/validate/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/authenticator/validate/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/authenticator/validate/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/webauthn/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/authenticator/webauthn/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/authenticator/webauthn/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/captcha/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/captcha/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/captcha/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/consent/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/consent/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/consent/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/deny/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/deny/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/deny/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/dummy/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/dummy/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/dummy/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/email/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/email/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/email/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/identification/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/identification/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/identification/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/invitation/invitations/ - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_obj` (object) - - > Flow Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/invitation/invitations/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > Invitation Serializer - - - Changed property `flow_obj` (object) - - > Flow Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/invitation/stages/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/invitation/stages/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/invitation/stages/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/password/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/password/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/password/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/prompt/stages/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/prompt/stages/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/prompt/stages/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_delete/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/user_delete/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/user_delete/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_login/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/user_login/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/user_login/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_logout/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/user_logout/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/user_logout/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_write/{stage_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/user_write/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/user_write/{stage_uuid}/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /core/user_consent/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > UserConsent Serializer - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - - - Changed property `application` (object) - - > Application Serializer - - New required properties: - - - `backchannel_providers_obj` - - * Added property `backchannel_providers` (array) - - * Added property `backchannel_providers_obj` (array) - - * Changed property `provider_obj` (object) - - > Provider Serializer - - New required properties: - - - `assigned_backchannel_application_name` - - `assigned_backchannel_application_slug` - - * Added 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 pass - > - `any` - any, any policy must pass - -##### `POST` /flows/bindings/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `notice` - Notice +> - `warning` - Warning +> - `alert` - Alert ##### `GET` /flows/bindings/ @@ -6572,1438 +1334,102 @@ Changed: `policy_engine_mode` in `query` > - `all` - all, all policies must pass > - `any` - any, any policy must pass -> -> - `all` - all, all policies must pass -> - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > FlowStageBinding Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /flows/executor/{flow_slug}/ - -###### Return Type: - -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_value` - - * Added property `initial_value` (string) - -##### `POST` /flows/executor/{flow_slug}/ - -###### Return Type: - -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_value` - - * Added property `initial_value` (string) - -##### `GET` /flows/inspector/{flow_slug}/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `plans` (array) - - Changed items (object): > Serializer for an active FlowPlan - - - Changed property `current_stage` (object) - - > FlowStageBinding Serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /oauth2/access_tokens/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /oauth2/authorization_codes/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /oauth2/refresh_tokens/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `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_name` - - `assigned_backchannel_application_slug` - - * Added 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 `sub_mode` (string) - - > - `hashed_user_id` - Based on the Hashed User ID - > - `user_id` - Based on user ID - > - `user_uuid` - Based on user UUID - > - `user_username` - Based on the username - > - `user_email` - Based on the User's Email. This is recommended over the UPN method. - > - `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. - - Added enum value: - - - `user_uuid` - - - Changed property `user` (object) - - > User Serializer - - New optional properties: - - - `groups` - -##### `GET` /stages/all/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > Stage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/authenticator/duo/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/duo/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > AuthenticatorDuoStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/authenticator/sms/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass ##### `GET` /stages/authenticator/sms/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `auth_type` in `query` -- Changed content type : `application/json` +> - `basic` - Basic +> - `bearer` - Bearer - - Changed property `results` (array) +Changed: `provider` in `query` - Changed items (object): > AuthenticatorSMSStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/authenticator/static/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/authenticator/static/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > AuthenticatorStaticStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/authenticator/totp/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `twilio` - Twilio +> - `generic` - Generic ##### `GET` /stages/authenticator/totp/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `digits` in `query` -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > AuthenticatorTOTPStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/authenticator/validate/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `6` - 6 digits, widely compatible +> - `8` - 8 digits, not compatible with apps like Google Authenticator ##### `GET` /stages/authenticator/validate/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `not_configured_action` in `query` -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > AuthenticatorValidateStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/authenticator/webauthn/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `skip` - Skip +> - `deny` - Deny +> - `configure` - Configure ##### `GET` /stages/authenticator/webauthn/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `authenticator_attachment` in `query` -- Changed content type : `application/json` +> - `platform` - Platform +> - `cross-platform` - Cross Platform - - Changed property `results` (array) +Changed: `resident_key_requirement` in `query` - Changed items (object): > AuthenticateWebAuthnStage Serializer +> - `discouraged` - Discouraged +> - `preferred` - Preferred +> - `required` - Required - - Changed property `flow_set` (array) +Changed: `user_verification` in `query` - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/captcha/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/captcha/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > CaptchaStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/consent/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `required` - Required +> - `preferred` - Preferred +> - `discouraged` - Discouraged ##### `GET` /stages/consent/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `mode` in `query` -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > ConsentStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/deny/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/deny/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > DenyStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/dummy/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/dummy/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > DummyStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/email/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/email/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > EmailStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/identification/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/identification/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > IdentificationStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/invitation/stages/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/invitation/stages/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > InvitationStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/password/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/password/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > PasswordStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/prompt/prompts/{prompt_uuid}/ - -###### Return Type: - -Changed response : **200 OK** - -- 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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PUT` /stages/prompt/prompts/{prompt_uuid}/ - -###### Request: - -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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- 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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `PATCH` /stages/prompt/prompts/{prompt_uuid}/ - -###### Request: - -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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- 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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/prompt/prompts/preview/ - -###### Request: - -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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `fields` (array) - - Changed items (object): > Serializer for a single Prompt field - - New required properties: - - - `initial_value` - - * Added property `initial_value` (string) - -##### `POST` /stages/prompt/stages/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/prompt/stages/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > PromptStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/user_delete/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_delete/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > UserDeleteStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/user_login/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_login/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > UserLoginStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/user_logout/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `GET` /stages/user_logout/ - -###### Return Type: - -Changed response : **200 OK** - -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > UserLogoutStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/user_write/ - -###### Request: - -Changed content type : `application/json` - -- Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- Changed content type : `application/json` - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `always_require` - Always Require +> - `permanent` - Permanent +> - `expiring` - Expiring ##### `GET` /stages/user_write/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `user_creation_mode` in `query` -- Changed content type : `application/json` - - - Changed property `results` (array) - - Changed items (object): > UserWriteStage Serializer - - - Changed property `flow_set` (array) - - Changed items (object): > Stripped down flow serializer - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -##### `POST` /stages/prompt/prompts/ - -###### Request: - -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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass - -###### Return Type: - -Changed response : **201 Created** - -- 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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `never_create` - Never Create +> - `create_when_required` - Create When Required +> - `always_create` - Always Create ##### `GET` /stages/prompt/prompts/ -###### Return Type: +###### Parameters: -Changed response : **200 OK** +Changed: `type` in `query` -- Changed content type : `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 - - - Changed property `policy_engine_mode` (string) - > - `all` - all, all policies must pass - > - `any` - any, any policy must pass +> - `text` - Text: Simple Text input +> - `text_area` - Text area: Multiline Text Input. +> - `text_read_only` - Text (read-only): Simple Text input, but cannot be edited. +> - `text_area_read_only` - Text area (read-only): Multiline Text input, but cannot be edited. +> - `username` - Username: Same as Text input, but checks for and prevents duplicate usernames. +> - `email` - Email: Text field with Email type. +> - `password` - Password: Masked input, multiple inputs of this type on the same prompt need to be identical. +> - `number` - Number +> - `checkbox` - Checkbox +> - `radio-button-group` - Fixed choice field rendered as a group of radio buttons. +> - `dropdown` - Fixed choice field rendered as a dropdown. +> - `date` - Date +> - `date-time` - Date Time +> - `file` - File: File upload for arbitrary files. File content will be available in flow context as data-URI +> - `separator` - Separator: Static Separator Line +> - `hidden` - Hidden: Hidden field, can be used to insert data into form. +> - `static` - Static: Static value, displayed as-is. +> - `ak-locale` - authentik: Selection of locales authentik supports diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index de57762f2..c139988ac 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -25,7 +25,7 @@ module.exports = async function () { title: "authentik", logo: { alt: "authentik logo", - src: "img/icon_left_brand.svg", + src: "img/icon.svg", }, items: [ { to: "blog", label: "Blog", position: "left" }, @@ -49,11 +49,6 @@ module.exports = async function () { label: "Pricing", position: "left", }, - { - to: "jobs/", - label: "Jobs", - position: "left", - }, { type: "dropdown", label: `Version: ${releases[0].replace( @@ -122,6 +117,11 @@ module.exports = async function () { { title: "More", items: [ + { + to: "jobs/", + label: "Jobs", + position: "left", + }, { label: "GitHub", href: "https://github.com/goauthentik/authentik", diff --git a/website/docusaurus.docs-only.js b/website/docusaurus.docs-only.js index b2f791687..5b72349d0 100644 --- a/website/docusaurus.docs-only.js +++ b/website/docusaurus.docs-only.js @@ -17,7 +17,7 @@ module.exports = async function () { title: "authentik", logo: { alt: "authentik logo", - src: "img/icon_left_brand.svg", + src: "img/icon.svg", }, items: [ { @@ -50,7 +50,10 @@ module.exports = async function () { }, ], }, - footer: mainConfig.themeConfig.footer, + footer: { + links: [], + copyright: mainConfig.themeConfig.footer.copyright, + }, colorMode: mainConfig.themeConfig.colorMode, tableOfContents: mainConfig.themeConfig.tableOfContents, },