diff --git a/providers/google-workspace/config/config.go b/providers/google-workspace/config/config.go index 4548620312..1c2f07a4bf 100644 --- a/providers/google-workspace/config/config.go +++ b/providers/google-workspace/config/config.go @@ -15,9 +15,25 @@ var Config = plugin.Provider{ ConnectionTypes: []string{provider.ConnectionType}, Connectors: []plugin.Connector{ { - Name: "google-workspace", - Use: "google-workspace", - Short: "Google Workspace", + Name: "google-workspace", + Use: "google-workspace [--credentials-path ] [--customer-id ] [--impersonated-user-email ]", + Short: "Google Workspace", + Long: `The google-workspace argument specifies that the interaction is intended for a Google Workspace domain. + +The provider requires three flags to be set: +'--customer-id ': This flag is used to specify the unique ID of the Google Workspace customer. +The customer ID is an immutable, unique identifier for a Google Workspace account. + +'--impersonated-user-email ': This flag is used to specify the email address of the user to +impersonate in this 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 is used to specify the file path to the credentials +file (typically a JSON file) that should be used for authentication. + +In case GOOGLE_APPLICATION_CREDENTIALS environment variable is set, the --credentials-path flag can be omitted. +`, + Aliases: []string{"googleworkspace"}, Discovery: []string{}, Flags: []plugin.Flag{ @@ -26,12 +42,14 @@ var Config = plugin.Provider{ Type: plugin.FlagType_String, Default: "", Desc: "The path to the service account credentials to access the APIs with", + Option: plugin.FlagOption_Required, }, { Long: "customer-id", Type: plugin.FlagType_String, Default: "", Desc: "Specify the Google Workspace customer id to scan", + Option: plugin.FlagOption_Required, }, { Long: "impersonated-user-email",