Method: locations.workforcePools.patch

Updates an existing WorkforcePool.

HTTP request

PATCH https://iam.googleapis.com/v1/{workforcePool.name=locations/*/workforcePools/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workforcePool.name

string

Identifier. The resource name of the pool.

Format: locations/{location}/workforcePools/{workforcePoolId}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of WorkforcePool.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.