From f4c75ba8a6bc34b05baabd1cc204db4a750aaef6 Mon Sep 17 00:00:00 2001 From: Pascal Jufer Date: Wed, 29 Nov 2023 11:30:41 +0100 Subject: [PATCH] Fix SSO SAML examples in docs (#20569) --- .changeset/shy-seahorses-sparkle.md | 5 +++++ docs/self-hosted/sso-examples.md | 16 +++++++--------- 2 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 .changeset/shy-seahorses-sparkle.md diff --git a/.changeset/shy-seahorses-sparkle.md b/.changeset/shy-seahorses-sparkle.md new file mode 100644 index 0000000000..51a59cd259 --- /dev/null +++ b/.changeset/shy-seahorses-sparkle.md @@ -0,0 +1,5 @@ +--- +"docs": patch +--- + +Made some corrections to the SSO SAML examples diff --git a/docs/self-hosted/sso-examples.md b/docs/self-hosted/sso-examples.md index 4c673239ca..a4c840578c 100644 --- a/docs/self-hosted/sso-examples.md +++ b/docs/self-hosted/sso-examples.md @@ -157,10 +157,9 @@ Twitter does not provide "email" so we define "username" as the identifier. ### AWS ``` -AUTH_SSO_DRIVER="saml" -AUTH_PROVIDERS="AWS" -AUTH_AWS_idp_metadata="{Your IAM Identity Center SAML metadata file}"" -AUTH_AWS_sp_metadata="" +AUTH_AWS_DRIVER="saml" +AUTH_AWS_IDP_metadata="{Your IAM Identity Center SAML metadata file}"" +AUTH_AWS_SP_metadata="" AUTH_AWS_ALLOW_PUBLIC_REGISTRATION="true" AUTH_AWS_DEFAULT_ROLE_ID="{Needs to be a valid role on the instance}" AUTH_AWS_IDENTIFIER_KEY="email" @@ -169,7 +168,7 @@ AUTH_AWS_EMAIL_KEY="email" ::: tip Metadata -- AWS IAM Docs are not that verbose. Users have found that the `sp_metadata` environment variable can be supplied empty. +- AWS IAM Docs are not that verbose. Users have found that the `SP_metadata` environment variable can be supplied empty. - Users have found that replacing `` in the IAM Identity Center SAML metadata file with your AWS Portal URL is a fix for getting the 'Login With SSO' @@ -195,10 +194,9 @@ Maps the email address into Directus as `external_identifier`: ### Google ``` -AUTH_SSO_DRIVER="saml" -AUTH_PROVIDERS="GOOGLE" -AUTH_GOOGLE_idp_metadata="{Your SAML metadata file from Google}"" -AUTH_GOOGLE_sp_metadata="{Create your own SAML metadata file, see example below}"" +AUTH_GOOGLE_DRIVER="saml" +AUTH_GOOGLE_IDP_metadata="{Your SAML metadata file from Google}"" +AUTH_GOOGLE_SP_metadata="{Create your own SAML metadata file, see example below}"" AUTH_GOOGLE_ALLOW_PUBLIC_REGISTRATION="true" AUTH_GOOGLE_DEFAULT_ROLE_ID="{Needs to be a valid role on the instance}" AUTH_GOOGLE_IDENTIFIER_KEY="email"