gcloud alpha agent-identity connectors update

NAME
gcloud alpha agent-identity connectors update - update connectors
SYNOPSIS
gcloud alpha agent-identity connectors update (CONNECTOR : --location=LOCATION) [--description=DESCRIPTION] [--request-id=REQUEST_ID] [--state=STATE] [--allowed-scopes=[ALLOWED_SCOPES,…]     | --add-allowed-scopes=[ADD_ALLOWED_SCOPES,…] --clear-allowed-scopes     | --remove-allowed-scopes=[REMOVE_ALLOWED_SCOPES,…]] [--blocked-scopes=[BLOCKED_SCOPES,…]     | --add-blocked-scopes=[ADD_BLOCKED_SCOPES,…] --clear-blocked-scopes     | --remove-blocked-scopes=[REMOVE_BLOCKED_SCOPES,…]] [--clear-connector-type-params --api-key=API_KEY     | --three-legged-oauth-authorization-url=THREE_LEGGED_OAUTH_AUTHORIZATION_URL --three-legged-oauth-client-id=THREE_LEGGED_OAUTH_CLIENT_ID --three-legged-oauth-client-secret=THREE_LEGGED_OAUTH_CLIENT_SECRET --three-legged-oauth-token-url=THREE_LEGGED_OAUTH_TOKEN_URL     | --two-legged-oauth-client-id=TWO_LEGGED_OAUTH_CLIENT_ID --two-legged-oauth-client-secret=TWO_LEGGED_OAUTH_CLIENT_SECRET --two-legged-oauth-token-endpoint=TWO_LEGGED_OAUTH_TOKEN_ENDPOINT] [--labels=[LABELS,…]     | --update-labels=[UPDATE_LABELS,…] --clear-labels     | --remove-labels=REMOVE_LABELS] [--workload-ids=[WORKLOAD_IDS,…]     | --add-workload-ids=[ADD_WORKLOAD_IDS,…] --clear-workload-ids     | --remove-workload-ids=[REMOVE_WORKLOAD_IDS,…]] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update a connector
EXAMPLES
To update the connector, run:
gcloud alpha agent-identity connectors update
POSITIONAL ARGUMENTS
Connector resource - Identifier. The full resource name of the connector. Format: projects/{project}/locations/{location}/connectors/{connector} The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument connector on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

CONNECTOR
ID of the connector or fully qualified identifier for the connector.

To set the connector attribute:

  • provide the argument connector on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--location=LOCATION
The location id of the connector resource.

To set the location attribute:

  • provide the argument connector on the command line with a fully specified name;
  • provide the argument --location on the command line.
FLAGS
--description=DESCRIPTION
Description of the resource. Must be less than 256 characters.
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

--state=STATE
The state of the connector. STATE must be one of:
disabled
Disabled and cannot be used.
enabled
Enabled and can be used.
Update allowed_scopes.

At most one of these can be specified:

--allowed-scopes=[ALLOWED_SCOPES,…]
Set allowed_scopes to new value.
Or at least one of these can be specified:
--add-allowed-scopes=[ADD_ALLOWED_SCOPES,…]
Add new value to allowed_scopes list.
At most one of these can be specified:
--clear-allowed-scopes
Clear allowed_scopes value and set to empty list.
--remove-allowed-scopes=[REMOVE_ALLOWED_SCOPES,…]
Remove existing value from allowed_scopes list.
Update blocked_scopes.

At most one of these can be specified:

--blocked-scopes=[BLOCKED_SCOPES,…]
Set blocked_scopes to new value.
Or at least one of these can be specified:
--add-blocked-scopes=[ADD_BLOCKED_SCOPES,…]
Add new value to blocked_scopes list.
At most one of these can be specified:
--clear-blocked-scopes
Clear blocked_scopes value and set to empty list.
--remove-blocked-scopes=[REMOVE_BLOCKED_SCOPES,…]
Remove existing value from blocked_scopes list.
Connector type specific parameters. Required when creating a connector.
--clear-connector-type-params
Set connector.connectorTypeParams back to default value.
Arguments for the type.

At most one of these can be specified:

Message describing ApiKeyParams object.
--api-key=API_KEY
The API key for this connector.
Message describing ThreeLeggedOAuth object.
--three-legged-oauth-authorization-url=THREE_LEGGED_OAUTH_AUTHORIZATION_URL
The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.atlassian.com/authorize"
--three-legged-oauth-client-id=THREE_LEGGED_OAUTH_CLIENT_ID
The client ID of the OAuth client.
--three-legged-oauth-client-secret=THREE_LEGGED_OAUTH_CLIENT_SECRET
The client secret of the OAuth client.
--three-legged-oauth-token-url=THREE_LEGGED_OAUTH_TOKEN_URL
The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.atlassian.com/oauth/token"
Message describing TwoLeggedOAuth object.
--two-legged-oauth-client-id=TWO_LEGGED_OAUTH_CLIENT_ID
The client ID of the OAuth client.
--two-legged-oauth-client-secret=TWO_LEGGED_OAUTH_CLIENT_SECRET
The client secret of the OAuth client.
--two-legged-oauth-token-endpoint=TWO_LEGGED_OAUTH_TOKEN_ENDPOINT
The token endpoint of the OAuth client.
Update labels.

At most one of these can be specified:

--labels=[LABELS,…]
Set labels to new value. Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
Shorthand Example:
--labels=string=string

JSON Example:

--labels='{"string": "string"}'

File Example:

--labels=path_to_file.(yaml|json)
Or at least one of these can be specified:
--update-labels=[UPDATE_LABELS,…]
Update labels value or add key value pair. Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
Shorthand Example:
--update-labels=string=string

JSON Example:

--update-labels='{"string": "string"}'

File Example:

--update-labels=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-labels
Clear labels value and set to empty map.
--remove-labels=REMOVE_LABELS
Remove existing value from map labels. Sets remove_labels value. Shorthand Example:
--remove-labels=string,string

JSON Example:

--remove-labels=["string"]

File Example:

--remove-labels=path_to_file.(yaml|json)
Update workload_ids.

At most one of these can be specified:

--workload-ids=[WORKLOAD_IDS,…]
Set workload_ids to new value.
Or at least one of these can be specified:
--add-workload-ids=[ADD_WORKLOAD_IDS,…]
Add new value to workload_ids list.
At most one of these can be specified:
--clear-workload-ids
Clear workload_ids value and set to empty list.
--remove-workload-ids=[REMOVE_WORKLOAD_IDS,…]
Remove existing value from workload_ids list.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE
This command uses the iamconnectors/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/iam/docs/
NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist.