Skip to content

Commit 9eee1ea

Browse files
MarcialRosalesmichaelklishin
authored andcommitted
Apply reviewer's feedback
1 parent 4a84ea1 commit 9eee1ea

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed

site/management.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -301,15 +301,14 @@ means it cannot securely store credentials such as the *client_secret*. This mea
301301
To redirect users to the UAA server to authenticate, use the following configuration:
302302

303303
<pre class="lang-ini">
304-
management.enable_uaa = true
304+
management.enable_uaa = true
305305
management.oauth_enabled = true
306306
management.oauth_client_id = rabbit_user_client
307307
management.oauth_provider_url = https://my-uaa-server-host:8443/uaa
308308
</pre>
309309

310-
> 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
313312
314313
### Allow Basic and OAuth 2 authentication
315314

@@ -401,20 +400,26 @@ In addition to the `connect-src` CSP header, RabbitMQ also needs the CSP directi
401400

402401
### Identity-Provider initiated logon
403402

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.
405404
However, there are scenarios where users preferred to be automatically redirected to RabbitMQ without getting
406405
involved in additional logon flows. This is common in Web Portals where with a single click, users navigate
407406
straight to a RabbitMQ cluster's management UI with a token obtained under the covers. This is known as
408407
**Identity-Provider initiated logon**.
409408

410409
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:
412416

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.
417+
<pre class="lang-ini">
418+
management.oauth_enabled = true
419+
management.oauth_initiated_logon_type = idp_initiated
420+
management.oauth_provider_url = https://my-web-portal
421+
</pre>
416422

417-
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.
418423

419424
## <a id="http-api" class="anchor" href="#http-api">HTTP API</a>
420425

site/oauth2-examples-keycloak.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,12 @@ rather than `legacy-token-key`.
107107

108108
### Configure Client
109109

110-
For backend applications which uses **Client Credentials flow** you create a **Client** with:
110+
For backend applications which uses **Client Credentials flow**, you can create a **Client** with:
111111

112112
* **Access Type** : `public`
113-
* With all the other flows disabled: Standard Flow, Implicit Flow, Direct Access Grants
113+
* Turn off `Standard Flow`, `Implicit Flow`, and `Direct Access Grants`
114114
* With **Service Accounts Enabled** on. If it is not enabled you do not have the tab `Credentials`
115-
* In tab `Credentials` you have the client id
115+
* In the `Credentials` tab, you have the `client id`
116116

117117

118118
### Configure Client scopes

site/oauth2-examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ The last command starts a RabbitMQ server with [this](https://github.com/rabbitm
9090

9191
## <a id="access-management-ui" class="anchor" href="#access-management-ui">Access Management UI using OAuth 2.0 tokens</a>
9292

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:
9494

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.
9797

9898
### <a id="service-provider-initiated-logon" class="anchor" href="#service-provider-initiated-logon">Service-Provider initiated logon</a>
9999

0 commit comments

Comments
 (0)