WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 6433828

Browse files
Predetermine authentication methods
1 parent 9f98c4d commit 6433828

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/management/index.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -658,6 +658,41 @@ And this is the management UI with Basic Authentication activated (`management.o
658658

659659
![More than one OAuth 2.0 resource, with oauth_disable_basic_auth = false](./management-oauth-many-with-basic-auth.png)
660660

661+
### Preselect or predetermine authentication mechanism {#preselect-auth-mechanism}
662+
663+
By default, when users navigate to the management UI home page, they see all available authentication mechanisms and can choose which one to use.
664+
However, in some scenarios, users may be routed to the management UI with an authentication mechanism already preselected or predefined. This allows external systems to guide users to a specific authentication flow.
665+
666+
To preselect or predetermine the authentication mechanism, users must sent to the `/login` endpoint with the
667+
appropriate request parameters. And the management ui redirects them back to the home page configured according
668+
to their preferred authentication mechanism.
669+
670+
The following request parameters control the behaviour:
671+
672+
#### Preselection Mode (preferred_auth_mechanism)
673+
674+
Use the `preferred_auth_mechanism` parameter to preselect an authentication method while still showing all options.
675+
676+
- **OAuth 2.0 resource**: `preferred_auth_mechanism=oauth2:rabbit_dev`
677+
- Preselects the OAuth 2.0 resource server, e.g. `rabbit_dev`
678+
- Expands the OAuth 2.0 section and collapses the basic authentication section in the home page
679+
680+
- **Basic authentication**: `preferred_auth_mechanism=basic`
681+
- Preselects basic authentication
682+
- Expands the basic authentication section and collapses the OAuth 2.0 section
683+
684+
#### Strict Mode (strict_auth_mechanism)
685+
686+
Use the `strict_auth_mechanism parameter` to show only the specified authentication method. Other methods are hidden.
687+
688+
- **OAuth 2.0 resource only**: `/login?strict_auth_mechanism=oauth2:rabbit_dev`
689+
- Shows only the "Click here to login" button for the `rabbit_dev` resource server
690+
- No other authentication options are displayed
691+
692+
- **Basic authentication only**: `/login?strict_auth_mechanism=basic`
693+
- Shows only the basic authentication form
694+
- No OAuth 2.0 options are displayed
695+
661696
### Troubleshooting {#troubleshooting}
662697

663698
[Troubleshooting management UI access in OAuth 2-enabled clusters](./troubleshooting-oauth2#management-ui) is a companion guide

0 commit comments

Comments
 (0)