Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update long-form help for google-workspace provider #4756

Merged
merged 1 commit into from
Oct 16, 2024
Merged

Update long-form help for google-workspace provider #4756

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions providers/google-workspace/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <customer-id>
cnquery shell google-workspace --credentials-path <credentials-path> --customer-id <customer-id>
cnspec scan google-workspace --credentials-path <credentials-path> --customer-id <customer-id>

* '--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 <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 <credentials-file-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"},
Expand All @@ -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.)",
},
},
},
Expand Down
Loading