prb connector command reference

Manage connectors. This page documents 10 commands under prb connector.

Flags and examples below come from the command definitions. A Required flag is explicitly marked required by Cobra; an unmarked flag can still be needed by runtime validation or a non-interactive workflow. Empty strings and empty lists are registered defaults, not sample values.

Every command also inherits the global flags. Run prb <command> --help to check your installed version. Replace placeholder IDs and names in source examples before running them. Return to the complete CLI command reference to browse another command.

Commands

Command	Description	Usage	Source
prb connector	Manage connectors.	prb connector <command>	View implementation
prb connector connect	Create a workload-identity connector.	prb connector connect	View implementation
prb connector create	Create an API-key or client-credentials connector.	prb connector create	View implementation
prb connector discover	Discover accounts under a connector.	prb connector discover <id>	View implementation
prb connector enable-accounts	Enable discovered connector accounts.	prb connector enable-accounts <connector-id>	View implementation
prb connector list	List connectors in an organization.	prb connector list	View implementation
prb connector providers	List providers prb connector create can connect.	prb connector providers	View implementation
prb connector update	Rename a connector.	prb connector update <connector-id>	View implementation
prb connector update-api-key	Replace a connector API key.	prb connector update-api-key <connector-id>	View implementation
prb connector view	View a connector.	prb connector view <id>	View implementation

prb connector

Manage connectors.

Usage

prb connector <command>

View command implementation.

prb connector connect

Create a workload-identity connector.

Usage

prb connector connect

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--aws-member-role-name	string	""	—	IAM role assumed in member accounts
--aws-role-arn	string	""	—	IAM role ARN
--azure-client-id	string	""	—	Entra application (client) ID
--azure-environment	string	""	—	Azure environment (AZURE_PUBLIC, AZURE_GOVERNMENT, …)
--azure-subscription-id	string	""	—	Azure subscription ID
--azure-tenant-id	string	""	—	Entra directory (tenant) ID
--gcp-parent	string	""	—	Cloud Asset parent (organizations/{n} or folders/{n})
--gcp-service-account-email	string	""	—	GCP service account email to impersonate
--gcp-workload-identity-provider	string	""	—	GCP workload identity provider resource
--json	boolean	false	—	Output JSON (same as —output json)
--name	string	""	—	A name that distinguishes this credential from other credentials for the same provider. For example, production or main.
--org	string	""	—	Organization ID
--organization	boolean	false	—	Connect an organization and list its accounts
--output, -o	string	""	—	Output format: json, table (default)
--provider	string	""	—	Connector provider (AWS, GCP, AZURE)

Examples

# Connect an AWS account
prb connector connect --name production --provider AWS \
  --aws-role-arn arn:aws:iam::123456789012:role/ProboAudit

# Connect an AWS organization
prb connector connect --organization --name production --provider AWS \
  --aws-role-arn arn:aws:iam::111111111111:role/ProboAudit

# Connect a GCP organization
prb connector connect --organization --name production --provider GCP \
  --gcp-workload-identity-provider projects/123/locations/global/workloadIdentityPools/probo/providers/probo \
  --gcp-service-account-email probo-audit@my-project.iam.gserviceaccount.com \
  --gcp-parent organizations/123456789

View command implementation.

prb connector create

Create an API-key or client-credentials connector.

Usage

prb connector create

Accepts no positional arguments.

Additional help

Creates a connector for a provider that needs no extra setting. A provider that needs a base URL, slug, or region is connected in the console. Use prb connector providers to list the providers this command accepts.

Flags

Flag	Type	Default	Required	Description
--api-key	string	""	—	Customer API key (or PROBO_CONNECTOR_API_KEY)
--client-id	string	""	—	OAuth client ID
--client-secret	string	""	—	OAuth client secret (or PROBO_CONNECTOR_CLIENT_SECRET)
--json	boolean	false	—	Output JSON (same as —output json)
--name	string	""	Required	Name that distinguishes this credential
--org	string	""	—	Organization ID
--output, -o	string	""	—	Output format: json, table (default)
--protocol	string	""	Required	api-key or client-credentials
--provider	string	""	Required	Connector provider
--scope	string	""	—	OAuth scope. The provider’s own scopes win when it declares them.
--token-url	string	""	—	Token endpoint. Leave empty when the provider pins one.

Examples

# API key from the environment, so it is not a process argument
PROBO_CONNECTOR_API_KEY=<key> prb connector create \
  --protocol api-key --provider NOTION --name production

# Or omit the key and type it at the prompt
prb connector create --protocol api-key --provider NOTION --name production

# Client secret from the environment
PROBO_CONNECTOR_CLIENT_SECRET=<secret> prb connector create \
  --protocol client-credentials --provider MONGODB_ATLAS \
  --name production --client-id <id>

# Or omit the secret and type it at the prompt
prb connector create --protocol client-credentials --provider MONGODB_ATLAS \
  --name production --client-id <id>

View command implementation.

prb connector discover

Discover accounts under a connector.

Usage

prb connector discover <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--json	boolean	false	—	Output JSON (same as —output json)
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.

prb connector enable-accounts

Enable discovered connector accounts.

Usage

prb connector enable-accounts <connector-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--account	string array	[]	—	Account to enable as external-id=name (repeatable)
--json	boolean	false	—	Output JSON (same as —output json)
--output, -o	string	""	—	Output format: json, table (default)

Examples

# Enable one account
prb connector enable-accounts <connector-id> --account 123456789012=Production

# Enable several accounts
prb connector enable-accounts <connector-id> \
  --account 123456789012=Production \
  --account 111111111111=Staging

View command implementation.

prb connector list

List connectors in an organization.

Usage

prb connector list

Accepts no positional arguments.

Flags

Flag	Type	Default	Required	Description
--json	boolean	false	—	Output JSON (same as —output json)
--org	string	""	—	Organization ID
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.

prb connector providers

List providers prb connector create can connect.

Usage

prb connector providers

Accepts no positional arguments.

Additional help

Lists providers that connect with an API key or client credentials and no extra setting. A provider that needs a base URL, slug, or region is connected in the console.

Flags

Flag	Type	Default	Required	Description
--json	boolean	false	—	Output JSON (same as —output json)
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.

prb connector update

Rename a connector.

Usage

prb connector update <connector-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--json	boolean	false	—	Output JSON (same as —output json)
--name	string	""	—	A name that distinguishes this credential from other credentials for the same provider. For example, production or main.
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.

prb connector update-api-key

Replace a connector API key.

Usage

prb connector update-api-key <connector-id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--api-key	string	""	—	Customer API key (or PROBO_CONNECTOR_API_KEY)
--json	boolean	false	—	Output JSON (same as —output json)
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.

prb connector view

View a connector.

Usage

prb connector view <id>

Requires 1 positional argument.

Flags

Flag	Type	Default	Required	Description
--json	boolean	false	—	Output JSON (same as —output json)
--output, -o	string	""	—	Output format: json, table (default)

View command implementation.