Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: default acr script validation #8715

Merged
merged 18 commits into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/admin/config-guide/custom-scripts-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pujavs if it is removed, what will be the fallback default authentication? Can AS live without any default authn method defined?

Copy link
Contributor Author

@pujavs pujavs Jun 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yuriyz, my understanding that AS can live without explicit setting of default auth method, request your confirmation and advice.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, if nothing works, and no scripts then AS will fallback to "simple_password_auth".


25 changes: 24 additions & 1 deletion docs/admin/config-guide/default-authentication-method-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -142,4 +164,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).
in the [Swagger document](./../reference/openapi.md).