From 89abc99dc09ff7b9ada62321037970ded2a28fe7 Mon Sep 17 00:00:00 2001 From: Jens L Date: Tue, 28 Mar 2023 12:05:44 +0200 Subject: [PATCH] website/docs: prepare 2023.4 release notes (#5083) * website/docs: prepare 2023.4 release notes Signed-off-by: Jens Langhammer * Update website/docs/releases/_template.md Co-authored-by: Tana M Berry Signed-off-by: Jens L. --------- Signed-off-by: Jens Langhammer Signed-off-by: Jens L. Co-authored-by: Tana M Berry --- Makefile | 5 +- website/developer-docs/releases/index.md | 4 +- website/docs/releases/2023/v2023.4.md | 1903 ++++++++++++++++++++++ website/docs/releases/_template.md | 2 + 4 files changed, 1912 insertions(+), 2 deletions(-) create mode 100644 website/docs/releases/2023/v2023.4.md diff --git a/Makefile b/Makefile index 2eb33c7eb..a93b60b1f 100644 --- a/Makefile +++ b/Makefile @@ -66,8 +66,11 @@ gen-build: AUTHENTIK_DEBUG=true ak make_blueprint_schema > blueprints/schema.json AUTHENTIK_DEBUG=true ak spectacular --file schema.yml +gen-changelog: + git log --pretty=format:" - %s" $(shell git describe --tags $(shell git rev-list --tags --max-count=1))...$(shell git branch --show-current) | sort > changelog.md + gen-diff: - git show $(shell git describe --abbrev=0):schema.yml > old_schema.yml + git show $(shell git describe --tags $(shell git rev-list --tags --max-count=1)):schema.yml > old_schema.yml docker run \ --rm -v ${PWD}:/local \ --user ${UID}:${GID} \ diff --git a/website/developer-docs/releases/index.md b/website/developer-docs/releases/index.md index ac8fba159..ff7dadd7d 100644 --- a/website/developer-docs/releases/index.md +++ b/website/developer-docs/releases/index.md @@ -22,6 +22,8 @@ - Paste the list of commits since the previous release under the `Minor changes/fixes` section. + Run `make gen-changelog` and use the contents of `changelog.md`. Remove merged PRs from bumped dependencies unless they fix security issues or are otherwise notable. Remove merged PRs with the `website/` prefix. + - Sort the list of commits alphabetically and remove all commits that have little importance, like dependency updates and linting fixes - Run `make gen-diff` and copy the contents of `diff.md` under `API Changes` @@ -36,7 +38,7 @@ - Paste the list of commits since the previous release into `website/docs/releases/v2022.12.md`, creating a new section called `## Fixed in 2022.12.2` underneath the `Minor changes/fixes` section - - Sort the list of commits alphabetically and remove all commits that have little importance, like dependency updates and linting fixes + - Run `make gen-changelog` and use the contents of `changelog.md`. Remove merged PRs from bumped dependencies unless they fix security issues or are otherwise notable. Remove merged PRs with the `website/` prefix. - Run `make gen-diff` and copy the contents of `diff.md` under `API Changes`, replacing the previous changes diff --git a/website/docs/releases/2023/v2023.4.md b/website/docs/releases/2023/v2023.4.md new file mode 100644 index 000000000..2925a4ce4 --- /dev/null +++ b/website/docs/releases/2023/v2023.4.md @@ -0,0 +1,1903 @@ +--- +title: Release 2023.4 +slug: "/releases/2023.4" +--- + +## New features + +## Upgrading + +This release does not introduce any new requirements. + +### docker-compose + +Download the docker-compose file for 2023.4 from [here](https://goauthentik.io/version/2023.4/docker-compose.yml). Afterwards, simply run `docker-compose up -d`. + +### Kubernetes + +Update your values to use the new images: + +```yaml +image: + repository: ghcr.io/goauthentik/server + tag: 2023.4.0 +``` + +## Minor changes/fixes + +- \*: load websocket paths similarly to URLs (#5018) +- blueprints: allow setting of token key in blueprint context (#4995) +- core: Add unique constraint to user UUID (#5004) +- providers: Add ability to choose a default authentication flow (#5070) +- providers/ldap: fix duplicate attributes (#4972) +- providers/oauth2: fix response for response_type code and response_mode fragment (#4975) +- providers/proxy: rework endpoints logic (#4993) +- providers/radius: simple radius outpost (#1796) +- stages/prompt: Add Radio Button Group, Dropdown and Text Area prompt fields (#4822) +- stages/user_login: stay logged in (#4958) +- web/admin: fix error adding users to groups (#5016) +- web/admin: fix error listing blueprints with missing metadata (#5041) +- web/admin: fix error when creating bindings due to hidden inputs (#5081) +- web/admin: fix inconsistent display of flows in selections (#4977) +- web/admin: fix prompt field display (#4990) +- web/admin: prompt preview (#5078) +- web/elements: fix search select inconsistency (#4989) +- web/elements: only render form once instance is loaded (#5049) +- web/flows: fix authenticator selector in dark mode (#4974) + +## API Changes + +#### What's New + +--- + +##### `GET` /outposts/radius/ + +##### `GET` /outposts/radius/{id}/ + +##### `GET` /providers/radius/ + +##### `POST` /providers/radius/ + +##### `GET` /providers/radius/{id}/ + +##### `PUT` /providers/radius/{id}/ + +##### `DELETE` /providers/radius/{id}/ + +##### `PATCH` /providers/radius/{id}/ + +##### `GET` /providers/radius/{id}/used_by/ + +##### `POST` /stages/prompt/prompts/preview/ + +#### What's Changed + +--- + +##### `GET` /policies/event_matcher/{policy_uuid}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - 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 + + Added enum value: + + - `authentik.providers.radius` + +##### `PUT` /policies/event_matcher/{policy_uuid}/ + +###### Request: + +Changed content type : `application/json` + +- 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 + + Added enum value: + + - `authentik.providers.radius` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - 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 + + Added enum value: + + - `authentik.providers.radius` + +##### `PATCH` /policies/event_matcher/{policy_uuid}/ + +###### Request: + +Changed content type : `application/json` + +- 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 + + Added enum value: + + - `authentik.providers.radius` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - 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 + + Added enum value: + + - `authentik.providers.radius` + +##### `GET` /providers/all/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/oauth2/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PUT` /providers/oauth2/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PATCH` /providers/oauth2/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/proxy/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PUT` /providers/proxy/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PATCH` /providers/proxy/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /core/applications/{slug}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PUT` /core/applications/{slug}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PATCH` /core/applications/{slug}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /outposts/instances/{uuid}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + + - Changed property `providers_obj` (array) + + Changed items (object): > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PUT` /outposts/instances/{uuid}/ + +###### Request: + +Changed content type : `application/json` + +- Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + + - Changed property `providers_obj` (array) + + Changed items (object): > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PATCH` /outposts/instances/{uuid}/ + +###### Request: + +Changed content type : `application/json` + +- Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + + - Changed property `providers_obj` (array) + + Changed items (object): > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /policies/event_matcher/ + +###### Request: + +Changed content type : `application/json` + +- 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 + + Added enum value: + + - `authentik.providers.radius` + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - 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 + + Added enum value: + + - `authentik.providers.radius` + +##### `GET` /policies/event_matcher/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > Event Matcher Policy Serializer + + - 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 + + Added enum value: + + - `authentik.providers.radius` + +##### `GET` /providers/all/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/ldap/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PUT` /providers/ldap/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PATCH` /providers/ldap/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /providers/oauth2/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/oauth2/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > OAuth2Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /providers/proxy/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/proxy/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > ProxyProvider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/saml/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PUT` /providers/saml/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `PATCH` /providers/saml/{id}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /core/applications/ + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /core/applications/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > Application Serializer + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /core/user_consent/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `application` (object) + + > Application Serializer + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /oauth2/access_tokens/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `provider` (object) + + > OAuth2Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /oauth2/authorization_codes/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `provider` (object) + + > OAuth2Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /oauth2/refresh_tokens/{id}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `provider` (object) + + > OAuth2Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /outposts/instances/ + +###### Request: + +Changed content type : `application/json` + +- Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Changed property `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + + - Changed property `providers_obj` (array) + + Changed items (object): > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `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 `type` (string) + + > - `proxy` - Proxy + > - `ldap` - Ldap + > - `radius` - Radius + + Added enum value: + + - `radius` + + - Changed property `providers_obj` (array) + + Changed items (object): > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /providers/ldap/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/ldap/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > LDAPProvider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `POST` /providers/saml/ + +###### Request: + +Changed content type : `application/json` + +- Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /providers/saml/ + +###### Parameters: + +Added: `authentication_flow` in `query` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > SAMLProvider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /stages/user_login/{stage_uuid}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +##### `PUT` /stages/user_login/{stage_uuid}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +##### `PATCH` /stages/user_login/{stage_uuid}/ + +###### Request: + +Changed content type : `application/json` + +- Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +##### `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 `application` (object) + + > Application Serializer + + - Changed property `provider_obj` (object) + + > Provider Serializer + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /flows/executor/{flow_slug}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + Added 'ak-stage-user-login' component: + + - Property `type` (string) + + > - `native` - NATIVE + > - `shell` - SHELL + > - `redirect` - REDIRECT + + Enum values: + + - `native` + - `shell` + - `redirect` + + - Property `flow_info` (object) + + > Contextual flow information for a challenge + + - Property `title` (string) + + - Property `background` (string) + + - Property `cancel_url` (string) + + - Property `layout` (string) + + > - `stacked` - STACKED + > - `content_left` - CONTENT_LEFT + > - `content_right` - CONTENT_RIGHT + > - `sidebar_left` - SIDEBAR_LEFT + > - `sidebar_right` - SIDEBAR_RIGHT + + Enum values: + + - `stacked` + - `content_left` + - `content_right` + - `sidebar_left` + - `sidebar_right` + + - Property `component` (string) + + - Property `response_errors` (object) + + - Property `pending_user` (string) + + - Property `pending_user_avatar` (string) + + Updated `ak-stage-prompt` component: + + - Changed property `fields` (array) + + Changed items (object): > Serializer for a single Prompt field + + New required properties: + + - `choices` + + * Added property `choices` (array) + + Items (string): + + * Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +##### `POST` /flows/executor/{flow_slug}/ + +###### Request: + +Changed content type : `application/json` + +Added 'ak-stage-user-login' component: + +- Property `component` (string) + +- Property `remember_me` (boolean) + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + Added 'ak-stage-user-login' component: + Updated `ak-stage-prompt` component: + + - Changed property `fields` (array) + + Changed items (object): > Serializer for a single Prompt field + + New required properties: + + - `choices` + + * Added property `choices` (array) + + * Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +##### `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 + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `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 + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `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 + + - Added property `authentication_flow` (string) + > Flow used for authentication when the associated application is accessed by an un-authenticated user. + +##### `GET` /stages/prompt/prompts/{prompt_uuid}/ + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + + - Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +##### `PUT` /stages/prompt/prompts/{prompt_uuid}/ + +###### Request: + +Changed content type : `application/json` + +- Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + +- Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + + - Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +##### `PATCH` /stages/prompt/prompts/{prompt_uuid}/ + +###### Request: + +Changed content type : `application/json` + +- Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + +- Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + + - Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +##### `POST` /stages/user_login/ + +###### Request: + +Changed content type : `application/json` + +- Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +##### `GET` /stages/user_login/ + +###### Parameters: + +Added: `remember_me_offset` in `query` + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > UserLoginStage Serializer + + - Added property `remember_me_offset` (string) + > Offset the session will be extended by when the user picks the remember me option. Default of 0 means that the remember me option will not be shown. (Format: hours=-1;minutes=-2;seconds=-3) + +##### `POST` /stages/prompt/prompts/ + +###### Request: + +Changed content type : `application/json` + +- Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + +- Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +###### Return Type: + +Changed response : **201 Created** + +- Changed content type : `application/json` + + - Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + + - Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` + +##### `GET` /stages/prompt/prompts/ + +###### Parameters: + +Changed: `type` in `query` + +> - `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 +> +> - `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 + +###### Return Type: + +Changed response : **200 OK** + +- Changed content type : `application/json` + + - Changed property `results` (array) + + Changed items (object): > Prompt Serializer + + - Changed property `placeholder` (string) + + > When creating a Radio Button Group or Dropdown, enable interpreting as expression and return a list to return multiple choices. + + - Changed property `type` (string) + + > - `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 + + Added enum values: + + - `text_area` + - `text_area_read_only` + - `radio-button-group` + - `dropdown` diff --git a/website/docs/releases/_template.md b/website/docs/releases/_template.md index 1185ec260..7466a6740 100644 --- a/website/docs/releases/_template.md +++ b/website/docs/releases/_template.md @@ -27,6 +27,8 @@ image: ## Minor changes/fixes +_Insert the output of `make gen-changelog` here_ + ## API Changes _Insert output of `make gen-diff` here_