Identity and Access Management (IAM) v1 API - Class GetRoleRequest (2.3.0)

public sealed class GetRoleRequest : IMessage<GetRoleRequest>, IEquatable<GetRoleRequest>, IDeepCloneable<GetRoleRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Identity and Access Management (IAM) v1 API class GetRoleRequest.

The request to get the definition of an existing role.

Inheritance

object > GetRoleRequest

Namespace

Google.Cloud.Iam.Admin.V1

Assembly

Google.Cloud.Iam.Admin.V1.dll

Constructors

GetRoleRequest()

public GetRoleRequest()

GetRoleRequest(GetRoleRequest)

public GetRoleRequest(GetRoleRequest other)
Parameter
NameDescription
otherGetRoleRequest

Properties

Name

public string Name { get; set; }

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

Property Value
TypeDescription
string

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
TypeDescription
IResourceName