Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in roles.list()
unless showDeleted
is set in the ListRolesRequest
. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed.
HTTP request
DELETE https://iam.googleapis.com/v1/{name=projects/*/roles/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
The
Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. Authorization requires the following Google IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
etag |
Used to perform a consistent read-modify-write. A base64-encoded string. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Role
.
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/iam
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.