Skip to content

Commit 757c2a7

Browse files
committed
document sso_redirect
1 parent 03e07b7 commit 757c2a7

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/modules/ROOT/pages/operations/browser-sso.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,6 @@ Example for Browser: +
150150
// |`auth_flow_step` | `auth_flow_step=<arg>` | `auth_flow_step=redirect_uri` | If the user arrives back to the client application with the URL param `auth_flow_step=redirect_uri`, this indicates that it is time to proceed in the auth process.
151151
// |`idp_id` | `idp_id=<idp_id>` | `idp_id=keycloak-oidc` | The user arrives with a URL param named idp_id, mapped to the information in the discovery data to figure out how to proceed.
152152
// |===
153+
154+
For convenience you can use the `sso_redirect=<idp_id>` url parameter to automatically trigger the SSO flow without needing to click the
155+
"Login with SSO" button in the Browser UI.

docs/modules/ROOT/pages/operations/browser-url-parameters.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,18 @@ http://localhost:7474/browser?preselectAuthMethod=[NATIVE]|[SSO]|[NO_AUTH]
5151
** `[SSO]` lets you sign in using SSO.
5252
** `[NO_AUTH]` means that no authorization is required.
5353

54+
You can automatically redirect to an SSO provider, as if a user clicked the corresponding SSO button in the UI with the `sso_redirect` url parameter.
55+
56+
The syntax is:
57+
58+
[source, browser URL, role=noheader]
59+
----
60+
http://localhost:7474/browser?sso_redirect=<idp_id>
61+
----
62+
63+
Where the `idp_id` is the `id` of the SSO provider. To ensure Browser finds the correct SSO providers, it's recommended you also pass the `connectURL`.
64+
65+
5466
== Pre-populate the editor
5567

5668
Pre-populate the editor with a command when Neo4j Browser starts.

0 commit comments

Comments
 (0)