From 7a79854f82dd9363861ea74e1baf5e03427da54b Mon Sep 17 00:00:00 2001 From: Sergiu Ghitea Date: Wed, 24 Aug 2022 14:33:30 +0200 Subject: [PATCH] Improve auth0 connection option scopes description --- docs/resources/connection.md | 2 +- internal/provider/resource_auth0_connection.go | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/resources/connection.md b/docs/resources/connection.md index 0c50e085c..978cdf0fc 100644 --- a/docs/resources/connection.md +++ b/docs/resources/connection.md @@ -456,7 +456,7 @@ Optional: - `provider` (String) Defines the custom `sms_gateway` provider. - `request_template` (String) Template that formats the SAML request. - `requires_username` (Boolean) Indicates whether the user is required to provide a username in addition to an email address. -- `scopes` (Set of String) Permissions to grant to the connection. +- `scopes` (Set of String) Permissions to grant to the connection. Within the Auth0 dashboard these appear under the "Attributes" and "Extended Attributes" sections. Some examples: `basic_profile`, `ext_profile`, `ext_nested_groups`, etc. - `scripts` (Map of String) A map of scripts used for an OAuth connection. Only accepts a `fetchUserProfile` script. - `set_user_root_attributes` (String) Determines whether the 'name', 'given_name', 'family_name', 'nickname', and 'picture' attributes can be independently updated when using an external IdP. Possible values are 'on_each_login' (default value, it configures the connection to automatically update the root attributes from the external IdP with each user login. When this setting is used, root attributes cannot be independently updated), 'on_first_login' (configures the connection to only set the root attributes on first login, allowing them to be independently updated thereafter). - `should_trust_email_verified_connection` (String) Choose how Auth0 sets the email_verified field in the user profile. diff --git a/internal/provider/resource_auth0_connection.go b/internal/provider/resource_auth0_connection.go index f7b907957..c7057c90d 100644 --- a/internal/provider/resource_auth0_connection.go +++ b/internal/provider/resource_auth0_connection.go @@ -541,11 +541,13 @@ var connectionSchema = map[string]*schema.Schema{ Description: "Version 1 is deprecated, use version 2.", }, "scopes": { - Type: schema.TypeSet, - Computed: true, - Optional: true, - Elem: &schema.Schema{Type: schema.TypeString}, - Description: "Permissions to grant to the connection.", + Type: schema.TypeSet, + Computed: true, + Optional: true, + Elem: &schema.Schema{Type: schema.TypeString}, + Description: "Permissions to grant to the connection. Within the Auth0 dashboard these appear " + + "under the \"Attributes\" and \"Extended Attributes\" sections. Some examples: " + + "`basic_profile`, `ext_profile`, `ext_nested_groups`, etc.", }, "type": { Type: schema.TypeString,