From ff3061d0779ed732e70e517fe186caf2e9c7a1ee Mon Sep 17 00:00:00 2001 From: pujavs <43700552+pujavs@users.noreply.github.com> Date: Fri, 28 Jun 2024 20:18:20 +0530 Subject: [PATCH] docs: default acr script validation (#8715) * docs: user password validation Signed-off-by: pujavs * docs: user password validation Signed-off-by: pujavs * docs: user password validation Signed-off-by: pujavs * docs: user password validation doc Signed-off-by: pujavs * docs: user password validation doc Signed-off-by: pujavs * docs: user password validation doc Signed-off-by: pujavs * docs: default acr script validation Signed-off-by: pujavs * docs: default acr script validation Signed-off-by: pujavs * docs: default acr script validation Signed-off-by: pujavs * docs: default acr script validation Signed-off-by: pujavs * docs: move the note about cust scripts and add link to docs * docs: add information about absence of default * docs: reword the note Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> * docs: remove the image from update section Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> --------- Signed-off-by: pujavs Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com> Co-authored-by: Dhaval D <343411+ossdhaval@users.noreply.github.com> Former-commit-id: 3784b34c39054979465b578bd77ff27918a15d1f --- .../config-guide/custom-scripts-config.md | 5 ++++ .../default-authentication-method-config.md | 25 ++++++++++++++++++- 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/admin/config-guide/custom-scripts-config.md b/docs/admin/config-guide/custom-scripts-config.md index 0045b602d1d..8512b4fc1e2 100644 --- a/docs/admin/config-guide/custom-scripts-config.md +++ b/docs/admin/config-guide/custom-scripts-config.md @@ -363,3 +363,8 @@ For example, in our case; the command line is: ``` That's all for `Custom Script` management with `CLI` feature. + +!!! Note + +If a custom script that is set as *Default authentication method* is disabled or deleted then the default authentication value will be removed. + diff --git a/docs/admin/config-guide/default-authentication-method-config.md b/docs/admin/config-guide/default-authentication-method-config.md index 07e021dfa65..4c654fe161a 100644 --- a/docs/admin/config-guide/default-authentication-method-config.md +++ b/docs/admin/config-guide/default-authentication-method-config.md @@ -11,6 +11,28 @@ The Janssen Server allows administrators to set and manage the default authentication method for the authentication server. The Janssen Server provides multiple configuration tools to perform these tasks. +!!! Note + + Only one of the available authentication methods can be set as the default. + While setting the Default authentication method, the Janssen Server + checks if the same authentication is available and active. + + See + [script documentation](custom-scripts-config.md#update-an-existing-custom-script) + to know how to enable/disable authentication methods using custom scripts. + + + If the script is not active then the following error notification is + returned by API. + ```{ + "code": "400", + "message": "INVALID_ACR", + "description": "Authentication script {acr} is not active" + } + ``` + + Also, to understand how Janssen Server picks the authentication method *in absence* of default authentication method, refer to [ACR documentation](../auth-server/openid-features/acrs.md#flowchart---how-the-jans-as-derives-an-acr-value-for-a-user-session-) + === "Use Command-line" Use the command line to perform actions from the terminal. Learn how to @@ -150,4 +172,5 @@ authentication method. Janssen Server Configuration REST API exposes relevant endpoints for managing and configuring the Default Authentication Method. Endpoint details are published -in the [Swagger document](./../reference/openapi.md). \ No newline at end of file +in the [Swagger document](./../reference/openapi.md). +