Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Method: projects.roles.get

HTTP request
Path parameters
Request body
Response body
Authorization scopes
Examples
Try it!

Gets the definition of a Role.

HTTP request

GET https://iam.s3nsapis.fr/v1/{name=projects/*/roles/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`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`

name

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

Request body

The request body must be empty.

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.