Method: projects.roles.get

Gets the definition of aRole.

HTTP request

GET https://iam.googleapis.com/v1/{name=projects/*/roles/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

  • roles.get:roles/{ROLE_NAME}. This method returns results from allpredefined roles in IAM. Example request URL:https://iam.googleapis.com/v1/roles/{ROLE_NAME}

  • projects.roles.get:projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method returns 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.get:organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method returns 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.get

Request body

The request body must be empty.

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.