From 59fb58b185e7e6d52e528bd213b8acf315e7bdef Mon Sep 17 00:00:00 2001 From: Fabi Date: Thu, 4 May 2023 08:32:02 +0200 Subject: [PATCH] docs: technical advisory (#5792) * docs: technical advisory * Update docs/sidebars.js Co-authored-by: mffap * Update docs/docs/support/advisory/a10000.md Co-authored-by: mffap * Update docs/docs/support/advisory/a10000.md Co-authored-by: mffap * Update docs/docs/support/advisory/a10000.md Co-authored-by: mffap --------- Co-authored-by: mffap --- docs/docs/support/advisory/a10000.md | 26 ++++++++++++++++ docs/docs/support/technical_advisory.mdx | 39 ++++++++++++++++++++++++ docs/sidebars.js | 15 +++++++++ 3 files changed, 80 insertions(+) create mode 100644 docs/docs/support/advisory/a10000.md create mode 100644 docs/docs/support/technical_advisory.mdx diff --git a/docs/docs/support/advisory/a10000.md b/docs/docs/support/advisory/a10000.md new file mode 100644 index 0000000000..9943bcc307 --- /dev/null +++ b/docs/docs/support/advisory/a10000.md @@ -0,0 +1,26 @@ +--- +title: Technical Advisory 10000 +--- + +## Description + +Currently, by default, users are directed to the "Select Account Page" on the ZITADEL login. +However, this can be modified by including a [prompt or a login hint](/docs/apis/openidoauth/endpoints#additional-parameters) in the authentication request. + +As a result of this default behavior, users who already have an active session in one application and wish to log in to a second one will need to select their user account, even if no other session is active. + +To address this, we are going to change this behavior so that users will be automatically authenticated when logging into a second application, as long as they only have one active session. + +## Statement + +This behaviour change is tracked in the following issue: [Reuse current session if no prompt is selected ](https://github.com/zitadel/zitadel/issues/4841) +As soon as the release version is published, we will include the version here. + +## Mitigation + +If you want to prompt users to always select their account on purpose, please make sure to include the `select_account` [prompt](/docs/apis/openidoauth/endpoints#additional-parameters) in your authentication request. + +## Impact + +Once this update has been released and deployed, your users will be automatically authenticated +No action will be required on your part if this is the intended behavior. diff --git a/docs/docs/support/technical_advisory.mdx b/docs/docs/support/technical_advisory.mdx new file mode 100644 index 0000000000..c866c32934 --- /dev/null +++ b/docs/docs/support/technical_advisory.mdx @@ -0,0 +1,39 @@ +--- +title: Technical Advisory +--- + +Technical advisories are notices that report major issues with ZITADEL Self-Hosted or the ZITADEL Cloud platform that could potentially impact security or stability in production environments. +These advisories may include details about the nature of the issue, its potential impact, and recommended mitigation actions. + +Users are strongly encouraged to evaluate these advisories and consider the recommended mitigation actions independently from their version upgrade schedule. +We understand that these advisories may include breaking changes, and we aim to provide clear guidance on how to address these changes. + + + + + + + + + + + + + + + + + + + +
AdvisoryNameTypeSummaryAffected versionsDate
A-10000Reusing user sessionBreaking Behaviour ChangeThe default behavior for users logging in is to be directed to the Select Account Page on the Login. With the upcoming changes, users will be automatically authenticated when logging into a second application, as long as they only have one active session. No action is required on your part if this is the intended behavior.TBDTBD
+ +## Categories + +### Breaking Behaviour Change + +A breaking behavior change refers to a modification or update that changes the behavior of ZITADEL. +This change does not necessarily affect the APIs or any functions you are calling, so it may not require an update to your code. +However, if you rely on specific results or behaviors, they may no longer be guaranteed after the change is implemented. +Therefore, it is important to be aware of breaking behavior changes and their potential impact on your use of ZITADEL, and to take appropriate action if needed to ensure continued functionality. + diff --git a/docs/sidebars.js b/docs/sidebars.js index 41ece73dab..ca0250612e 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -310,6 +310,21 @@ module.exports = { collapsed: true, items: [ "support/troubleshooting", + { + type: 'category', + label: "Technical Advisory", + link: { + type: 'doc', + id: 'support/technical_advisory', + }, + collapsed: true, + items: [ + { + type: 'autogenerated', + dirName: 'support/advisory', + }, + ], + }, { type: "category", label: "Trainings",