Method: locations.workforcePools.subjects.delete

Deletes aWorkforcePoolSubject.

Subject must not already be in a deleted state.

AWorkforcePoolSubject is automatically created the first time an external credential is exchanged for a Google Cloud credential using a mappedgoogle.subject attribute. There is no endpoint to manually create aWorkforcePoolSubject.

For 30 days after aWorkforcePoolSubject is deleted, using the samegoogle.subject attribute in token exchanges with Google Cloud STS fails.

Callsubjects.undelete to undelete aWorkforcePoolSubject that has been deleted, within within 30 days of deleting it.

After 30 days, theWorkforcePoolSubject is permanently deleted. At this point, a token exchange with Google Cloud STS that uses the same mappedgoogle.subject attribute automatically creates a newWorkforcePoolSubject that is unrelated to the previously deletedWorkforcePoolSubject but has the samegoogle.subject value.

HTTP request

DELETE https://iam.googleapis.com/v1/{name=locations/*/workforcePools/*/subjects/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of theWorkforcePoolSubject. Special characters, like/ and:, must be escaped, because all URLs need to conform to the "When to Escape and Unescape" section ofRFC3986.

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

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance ofOperation.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-21 UTC.