- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Examples
- Try it!
Updates the definition of a custom Role
.
HTTP request
PATCH https://iam.googleapis.com/v1/{name=organizations/*/roles/*}
The URL uses gRPC Transcoding syntax.
Path parameters
name
string
The name
parameter's value depends on the target resource for the request, namely projects
or organizations
. Each resource type's name
value format is described below:
-
projects.roles.patch :
projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the project level. Example request URL:https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID} -
organizations.roles.patch :
organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method updates only custom roles that have been created at the organization level. Example request URL:https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.
Authorization requires the following IAM
permission on the specified resource name
:
-
iam.roles.update
Query parameters
| Parameters | |
|---|---|
updateMask
|
A mask describing which fields in the Role have changed. This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of Role
.
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 .
