From 757c2a737e2a209fe72567492a3ad9759c749a50 Mon Sep 17 00:00:00 2001 From: Oskar Damkjaer Date: Thu, 19 Sep 2024 15:52:41 +0200 Subject: [PATCH] document sso_redirect --- docs/modules/ROOT/pages/operations/browser-sso.adoc | 3 +++ .../pages/operations/browser-url-parameters.adoc | 12 ++++++++++++ 2 files changed, 15 insertions(+) diff --git a/docs/modules/ROOT/pages/operations/browser-sso.adoc b/docs/modules/ROOT/pages/operations/browser-sso.adoc index c7921ce7d61..d4753278ce4 100644 --- a/docs/modules/ROOT/pages/operations/browser-sso.adoc +++ b/docs/modules/ROOT/pages/operations/browser-sso.adoc @@ -150,3 +150,6 @@ Example for Browser: + // |`auth_flow_step` | `auth_flow_step=` | `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=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=` url parameter to automatically trigger the SSO flow without needing to click the +"Login with SSO" button in the Browser UI. \ No newline at end of file diff --git a/docs/modules/ROOT/pages/operations/browser-url-parameters.adoc b/docs/modules/ROOT/pages/operations/browser-url-parameters.adoc index 0f1429a86f1..ed124b87739 100644 --- a/docs/modules/ROOT/pages/operations/browser-url-parameters.adoc +++ b/docs/modules/ROOT/pages/operations/browser-url-parameters.adoc @@ -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= +---- + +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.