From a8c4fb7434831c3ee97ce334f9079a552eb13709 Mon Sep 17 00:00:00 2001 From: Meng Zhang Date: Tue, 23 Apr 2024 14:31:12 -0700 Subject: [PATCH] docs: add administration doc on SSO config (#1940) * docs: add administration doc on SSO config * update * update * update --- website/docs/administration/sso/index.mdx | 28 +++++++++++++++++++ .../administration/sso/integrations_sso.png | 3 ++ .../docs/administration/sso/sso_create.png | 3 ++ .../docs/administration/sso/sso_signin.png | 3 ++ 4 files changed, 37 insertions(+) create mode 100644 website/docs/administration/sso/index.mdx create mode 100644 website/docs/administration/sso/integrations_sso.png create mode 100644 website/docs/administration/sso/sso_create.png create mode 100644 website/docs/administration/sso/sso_signin.png diff --git a/website/docs/administration/sso/index.mdx b/website/docs/administration/sso/index.mdx new file mode 100644 index 000000000000..ed6b4a7cd58d --- /dev/null +++ b/website/docs/administration/sso/index.mdx @@ -0,0 +1,28 @@ +import SSOCreateUrl from "./sso_create.png"; +import SSOSigninUrl from "./sso_signin.png"; + +# Single Sign-On + +:::subscription +This feature is available in the **Enterprise** plans. +::: + +Single Sign-On (SSO) is an authentication method that enables users to securely authenticate with multiple applications using just one set of credentials. + +## Create an Identity Provider + +1. Navigate to the **Integrations > SSO** page. + + ![Integrations > SSO](./integrations_sso.png) + +2. Click **Create** to begin the process of creating an identity provider. (Currently, as of version 0.10, only GitHub OAuth and Google OAuth are supported. More options are forthcoming.) + + Create SSO + +3. Complete all the required fields and submit the form with **Create** button. + +## Sign in with SSO + +After a valid identity provider has been established, users can select the provider to sign in with. + +Sign in with SSO diff --git a/website/docs/administration/sso/integrations_sso.png b/website/docs/administration/sso/integrations_sso.png new file mode 100644 index 000000000000..c28ca3d52419 --- /dev/null +++ b/website/docs/administration/sso/integrations_sso.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae41718dc046a9bcbf2504b15200aba139edd92893a466d450a3fbac3379164f +size 200809 diff --git a/website/docs/administration/sso/sso_create.png b/website/docs/administration/sso/sso_create.png new file mode 100644 index 000000000000..4a95f9f4de72 --- /dev/null +++ b/website/docs/administration/sso/sso_create.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b68ac87de0739fcdcddf173ebf47e437d55c84e6f5280511b31918308360c36 +size 166547 diff --git a/website/docs/administration/sso/sso_signin.png b/website/docs/administration/sso/sso_signin.png new file mode 100644 index 000000000000..d692a2a0c9bf --- /dev/null +++ b/website/docs/administration/sso/sso_signin.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b68539e4f1e96eea82e37cab8d02c1e9c78498293e99a348d4dc507c685105d +size 79842