Method: organizations.roles.patch

Updates the definition of a customRole.

HTTP request

PATCH https://iam.googleapis.com/v1/{name=organizations/*/roles/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Thename parameter's value depends on the target resource for the request, namelyprojects ororganizations. Each resource type'sname value format is described below:

  • projects.roles.patch:projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method updates onlycustom 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 onlycustom 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 followingIAM permission on the specified resourcename:

  • iam.roles.update

Query parameters

Parameters
updateMask

string (FieldMask format)

A mask describing which fields in the Role have changed.

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

Request body

The request body contains an instance ofRole.

Response body

If successful, the response body contains an instance ofRole.

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