Class Policy

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] }

YAML Example

bindings:

members:
- user:mike@example.com
- group:admins@example.com
- domain:google.com
- serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin
members:
- user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer's guide.

Inheritance

System.Object

Policy

Implements

IMessage<Policy>

IMessage

System.IEquatable<Policy>

IDeepCloneable<Policy>

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Iam.V1

Assembly: Google.Cloud.Iam.V1.dll

Syntax

public sealed class Policy : IMessage<Policy>, IMessage, IEquatable<Policy>, IDeepCloneable<Policy>

Constructors

Policy()

Declaration

public Policy()

Policy(Policy)

Declaration

public Policy(Policy other)

Parameters

Type	Name	Description
Policy	other

Properties

Bindings

Associates a list of members to a role. Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error.

Declaration

public RepeatedField<Binding> Bindings { get; }

Property Value

Type	Description
RepeatedField<Binding>

Etag

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.

If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy.

Declaration

public ByteString Etag { get; set; }

Property Value

Type	Description
ByteString

Version

Specifies the format of the policy.

Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.

Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset.

If no etag is provided in the call to setIamPolicy, version compliance checks against the stored policy is skipped.

Declaration

public int Version { get; set; }

Property Value

Type	Description
System.Int32

Methods

AddRoleMember(String, String)

Adds the specified member to the specified role. If the role does not already exist, it is created. This method will fail with an System.InvalidOperationException if it is called on a Policy with a Version greater than 1, or if any of the bindings contain conditions, as that indicates a more complicated policy than this method is prepared to handle. Changes to such policies must be made manually.

Declaration

public bool AddRoleMember(string role, string member)

Parameters

Type	Name	Description
System.String	role	The role to add the member to. Must not be null or empty.
System.String	member	The member to add to the role. Must not be null or empty.

Returns

Type	Description
System.Boolean	`true` if the policy was changed; `false` if the member already existed in the role.

Exceptions

Type	Condition
System.InvalidOperationException	The Version is greater than 1.

RemoveRoleMember(String, String)

Removes the specified member to the specified role, if they belong to it. If the role becomes empty after removing the member, it is removed from the policy. This method will fail with an System.InvalidOperationException if it is called on a Policy with a Version greater than 1, or if any of the bindings contain conditions, as that indicates a more complicated policy than this method is prepared to handle. Changes to such policies must be made manually.

Declaration

public bool RemoveRoleMember(string role, string member)

Parameters

Type	Name	Description
System.String	role	The role to remove the member from. Must not be null or empty.
System.String	member	The member to remove from the role. Must not be null or empty.

Returns

Type	Description
System.Boolean	`true` if the policy was changed; `false` if the member didn't exist in the role or the role didn't exist.

Exceptions

Type	Condition
System.InvalidOperationException	The Version is greater than 1.