Class: Google::Apis::IamV1::Policy
- Inherits:
-
Object
- Object
- Google::Apis::IamV1::Policy
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/iam_v1/classes.rb,
generated/google/apis/iam_v1/representations.rb,
generated/google/apis/iam_v1/representations.rb
Overview
Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy
consists of a list of bindings
. A Binding
binds a list of
members
to a role
, where the members can be user accounts, Google groups,
Google domains, and service accounts. A role
is a named list of permissions
defined by IAM.
Example
"bindings": [
"role": "roles/owner",
"members": [
"user:mike@example.com",
"group:admins@example.com",
"domain:google.com",
"serviceAccount:my-other-app@appspot.gserviceaccount.com",
]
,
"role": "roles/viewer",
"members": ["user:sean@example.com"]
]
For a description of IAM and its features, see the
IAM developer's guide.
Instance Attribute Summary collapse
-
#bindings ⇒ Array<Google::Apis::IamV1::Binding>
Associates a list of
members
to arole
. -
#etag ⇒ String
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. -
#version ⇒ Fixnum
Version of the
Policy
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Policy
constructor
A new instance of Policy.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Policy
Returns a new instance of Policy
763 764 765 |
# File 'generated/google/apis/iam_v1/classes.rb', line 763 def initialize(**args) update!(**args) end |
Instance Attribute Details
#bindings ⇒ Array<Google::Apis::IamV1::Binding>
Associates a list of members
to a role
.
Multiple bindings
must not be specified for the same role
.
bindings
with no members will result in an error.
Corresponds to the JSON property bindings
761 762 763 |
# File 'generated/google/apis/iam_v1/classes.rb', line 761 def bindings @bindings end |
#etag ⇒ String
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 blindly.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
749 750 751 |
# File 'generated/google/apis/iam_v1/classes.rb', line 749 def etag @etag end |
#version ⇒ Fixnum
Version of the Policy
. The default version is 0.
Corresponds to the JSON property version
754 755 756 |
# File 'generated/google/apis/iam_v1/classes.rb', line 754 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
768 769 770 771 772 |
# File 'generated/google/apis/iam_v1/classes.rb', line 768 def update!(**args) @etag = args[:etag] if args.key?(:etag) @version = args[:version] if args.key?(:version) @bindings = args[:bindings] if args.key?(:bindings) end |