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

🧹 update google workspace cli docs #2011

Merged
merged 1 commit into from
Oct 1, 2023
Merged

🧹 update google workspace cli docs #2011

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
24 changes: 21 additions & 3 deletions providers/google-workspace/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <credentials-path>] [--customer-id <customer-id>] [--impersonated-user-email <impersonated-user-email>]",
Short: "Google Workspace",
Long: `google-workspace is designed for querying resources within for a Google Workspace domain.

The provider requires three flags to be set:
'--customer-id <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 <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 <credentials-file-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{
Expand All @@ -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",
Expand Down
Loading