Skip to content

Commit

Permalink
document sso_redirect
Browse files Browse the repository at this point in the history
  • Loading branch information
OskarDamkjaer committed Sep 19, 2024
1 parent 03e07b7 commit 757c2a7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/operations/browser-sso.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,6 @@ Example for Browser: +
// |`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.
// |`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.
// |===

For convenience you can use the `sso_redirect=<idp_id>` url parameter to automatically trigger the SSO flow without needing to click the
"Login with SSO" button in the Browser UI.
12 changes: 12 additions & 0 deletions docs/modules/ROOT/pages/operations/browser-url-parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@ http://localhost:7474/browser?preselectAuthMethod=[NATIVE]|[SSO]|[NO_AUTH]
** `[SSO]` lets you sign in using SSO.
** `[NO_AUTH]` means that no authorization is required.

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.

The syntax is:

[source, browser URL, role=noheader]
----
http://localhost:7474/browser?sso_redirect=<idp_id>
----

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


== Pre-populate the editor

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

0 comments on commit 757c2a7

Please sign in to comment.