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

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

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

A role in the Identity and Access Management API.

Inheritance

object > Role

Implements

IMessage Role, IEquatable Role, IDeepCloneable Role, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Iam.Admin.V1

Assembly

Google.Cloud.Iam.Admin.V1.dll

Constructors

Role()

public Role()

Role(Role)

public Role(Role other)

Parameter
Name	Description
`other`	`Role`

Properties

Deleted

public bool Deleted { get; set; }

The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

Property Value
Type	Description
`bool`

Description

public string Description { get; set; }

Optional. A human-readable description for the role.

Property Value
Type	Description
`string`

Etag

public ByteString Etag { get; set; }

Used to perform a consistent read-modify-write.

Property Value
Type	Description
`ByteString`

IncludedPermissions

public RepeatedField<string> IncludedPermissions { get; }

The names of the permissions this role grants when bound in an IAM policy.

Property Value
Type	Description
`RepeatedFieldstring`

Name

public string Name { get; set; }

The name of the role.

When Role is used in CreateRole, the role name must not be set.

When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

Property Value
Type	Description
`string`

Stage

public Role.Types.RoleLaunchStage Stage { get; set; }

The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.

Property Value
Type	Description
`RoleTypesRoleLaunchStage`

Title

public string Title { get; set; }

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Property Value
Type	Description
`string`