Stay organized with collections Save and categorize content based on your preferences.
Gets the definition of a Role
.
GET https://iam.googleapis.com/v1/{name=roles/*}
The URL uses gRPC Transcoding syntax.
Path parameters Parametersname
string
The name
parameter's value depends on the target resource for the request, namely roles, projects, or organizations. Each resource type's name
value format is described below:
roles.get: roles/{ROLE_NAME}
. This method returns results from all predefined 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 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.get: organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}
. This method returns 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.get
The request body must be empty.
Response bodyIf successful, the response body contains an instance of Role
.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["This page details how to retrieve the definition of a specific Role using the IAM API."],["The `GET` HTTP request method is used, with the URL structure determined by the resource type (roles, projects, or organizations)."],["The `name` parameter in the URL specifies the target resource and follows different formats based on the resource type and whether it's a predefined or custom role."],["The request body must be empty, and a successful request will return a Role instance in the response body."],["Authorization for this operation requires specific IAM permissions (`iam.roles.get`) and one of two specified OAuth scopes."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4