You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> IMPORTANT: Since RabbitMQ 3.10, RabbitMQ uses `authorization_code` grant type. `implicit` flow has been
311
-
deprecated.
312
-
> IMPORTANT: management.oauth_client_secret is an optional setting. It is only required when your authorization server requires it
310
+
> IMPORTANT: Since RabbitMQ 3.10, RabbitMQ uses `authorization_code` grant type. `implicit` flow is deprecated.
311
+
> IMPORTANT: `management.oauth_client_secret` is an optional setting. It is only required when your authorization server requires it
313
312
314
313
### Allow Basic and OAuth 2 authentication
315
314
@@ -401,20 +400,26 @@ In addition to the `connect-src` CSP header, RabbitMQ also needs the CSP directi
401
400
402
401
### Identity-Provider initiated logon
403
402
404
-
By default, the Management UI uses OAuth 2.0 authorization code flow to authenticate and authorize users.
403
+
By default, the RabbitMQ Management UI uses the OAuth 2.0 **authorization code flow** to authenticate and authorize users.
405
404
However, there are scenarios where users preferred to be automatically redirected to RabbitMQ without getting
406
405
involved in additional logon flows. This is common in Web Portals where with a single click, users navigate
407
406
straight to a RabbitMQ cluster's management UI with a token obtained under the covers. This is known as
408
407
**Identity-Provider initiated logon**.
409
408
410
409
RabbitMQ exposes a new setting called `management.oauth_initiated_logon_type` whose default value `sp_initiated`.
411
-
To enable an **Identity-Provider initiated logon** we set it to `idp_initiated`.
410
+
To enable an **Identity-Provider initiated logon** you set it to `idp_initiated`.
411
+
412
+
After you set `management.oauth_initiated_logon_type` to `idp_initiated` and
413
+
`oauth_enabled: true` and `oauth_provider_url` are configured, the management UI exposes the HTTP endpoint `/login` which accepts `content-type: application/x-www-form-urlencoded` and it expects the JWT token in the `access_token` form field. This is the endpoint where the web portal would redirect users to access the RabbitMQ Management ui.
414
+
415
+
This is the minimum required configuration for a RabbitMQ cluster configured with `idp_initiated` logon type:
412
416
413
-
When we set `management.oauth_initiated_logon_type` to `idp_initiated` the minimum required configuration is
414
-
`oauth_enabled: true` and `oauth_provider_url`. The other settings related to OAuth are not required.
415
-
The `oauth_provider_url` should be the web portal address.
Once we set `management.oauth_initiated_logon_type` to `idp_initiated`, the management UI exposes the endpoint `/login` which accepts `content-type: application/x-www-form-urlencoded` and it expects the JWT token in the `access_token` form field.
Copy file name to clipboardExpand all lines: site/oauth2-examples.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -90,10 +90,10 @@ The last command starts a RabbitMQ server with [this](https://github.com/rabbitm
90
90
91
91
## <aid="access-management-ui"class="anchor"href="#access-management-ui">Access Management UI using OAuth 2.0 tokens</a>
92
92
93
-
The Management UI can be configured with one of these two login modes:
93
+
The RabbitMQ Management UI can be configured with one of these two login modes:
94
94
95
-
*[Service-Provider initiated logon](#service-provider-initiated-logon) - This is the default and traditional OAuth 2.0 logon mode. The user comes to the Management UI and clicks on the button "Click here to logon" which initiates the logon. The logon process starts in RabbitMQ, the *Service Provider*.
96
-
*[Identity-Provider initiated logon](#identity-provider-initiated-logon) - This is a logon mode meant for web portals. Users navigate to RabbitMQ with a token already obtained by the web portal on behalf of the user.
95
+
*[Service-Provider initiated logon](#service-provider-initiated-logon) - This is the default and traditional OAuth 2.0 logon mode. In the RabbitMQ Management UI, click `Click here to logon` to initiate the logon. The logon process starts in RabbitMQ, the *Service Provider*.
96
+
*[Identity-Provider initiated logon](#identity-provider-initiated-logon) - You can use this logon mode for web portals. Users can navigate to RabbitMQ with an existing token which is retrieved from the web portal on behalf of the user.
0 commit comments