Thenameparameter's value depends on the target resource for the request, namelyroles,projects, ororganizations. Each resource type'snamevalue format is described below:
roles.get:roles/{ROLE_NAME}. This method returns results from allpredefined rolesin 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 rolesthat 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 rolesthat 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 followingIAMpermission 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.
[[["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."],[[["\u003cp\u003eThis page details how to retrieve the definition of a specific Role using the IAM API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGET\u003c/code\u003e HTTP request method is used, with the URL structure determined by the resource type (roles, projects, or organizations).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e 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.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and a successful request will return a Role instance in the response body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires specific IAM permissions (\u003ccode\u003eiam.roles.get\u003c/code\u003e) and one of two specified OAuth scopes.\u003c/p\u003e\n"]]],[],null,["# Method: roles.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nGets the definition of a [Role](/iam/docs/reference/rest/v1/organizations.roles#Role).\n\n### HTTP request\n\n`GET https://iam.googleapis.com/v1/{name=roles/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Role](/iam/docs/reference/rest/v1/organizations.roles#Role).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/iam`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
