From fc2cb8f570d4cf6a07c1489cd3d55dd1cb01b0ff Mon Sep 17 00:00:00 2001 From: misterpantz Date: Tue, 15 Oct 2024 16:19:38 -0700 Subject: [PATCH] Update long-form help for google-workspace provider --- providers/google-workspace/config/config.go | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/providers/google-workspace/config/config.go b/providers/google-workspace/config/config.go index de96fa6f21..387887b841 100644 --- a/providers/google-workspace/config/config.go +++ b/providers/google-workspace/config/config.go @@ -21,13 +21,14 @@ var Config = plugin.Provider{ Short: "a Google Workspace account", Long: `Use the google-workspace provider to query resources in a Google Workspace domain. -The provider requires these three flags: +Examples: + cnquery shell google-workspace --customer-id + cnquery shell google-workspace --credentials-path --customer-id + cnspec scan google-workspace --credentials-path --customer-id -* '--customer-id ': This flag specifies the unique ID of the Google Workspace customer. The customer ID is an immutable, unique identifier for a Google Workspace account. +Note: -* '--impersonated-user-email ': This flag specifies the email address of the user to impersonate in the session. This is useful when the user executing the command does not have the necessary permissions, but can impersonate a user who does. - -* '--credentials-path ': This flag specifies the path to the credentials file (typically a JSON file) to use for authentication. You can omit this flag if the GOOGLE_APPLICATION_CREDENTIALS environment variable is set. +If you set the GOOGLE_APPLICATION_CREDENTIALS environment variable, you don't need to provide the --credentials-path flag. `, Aliases: []string{"googleworkspace"}, @@ -37,21 +38,21 @@ The provider requires these three flags: Long: "credentials-path", Type: plugin.FlagType_String, Default: "", - Desc: "Path to the service account credentials with which to access the APIs", + Desc: "Path to the service account credentials file (typically a JSON file) with which to access the APIs", Option: plugin.FlagOption_Required, }, { Long: "customer-id", Type: plugin.FlagType_String, Default: "", - Desc: "Google Workspace customer ID to scan", + Desc: "Unique ID of the Google Workspace customer account", Option: plugin.FlagOption_Required, }, { Long: "impersonated-user-email", Type: plugin.FlagType_String, Default: "", - Desc: "Email address of the user to impersonate in the session", + Desc: "Email address of the user to impersonate in the session (This is useful when the user executing the command does not have the necessary permissions, but can impersonate a user who does.)", }, }, },