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.
JSON 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"]
]
YAML Example
bindings:
- members:
- user:mike@example.com
- group:admins@example.com
- domain:google.com
- serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner
- members:
- user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide.
Instance Attribute Summary collapse
-
#audit_configs ⇒ Array<Google::Apis::IamV1::AuditConfig>
Specifies cloud audit logging configuration for this policy.
-
#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
Deprecated.
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
943 944 945 |
# File 'generated/google/apis/iam_v1/classes.rb', line 943 def initialize(**args) update!(**args) end |
Instance Attribute Details
#audit_configs ⇒ Array<Google::Apis::IamV1::AuditConfig>
Specifies cloud audit logging configuration for this policy.
Corresponds to the JSON property auditConfigs
916 917 918 |
# File 'generated/google/apis/iam_v1/classes.rb', line 916 def audit_configs @audit_configs end |
#bindings ⇒ Array<Google::Apis::IamV1::Binding>
Associates a list of members
to a role
.
bindings
with no members will result in an error.
Corresponds to the JSON property bindings
922 923 924 |
# File 'generated/google/apis/iam_v1/classes.rb', line 922 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.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
936 937 938 |
# File 'generated/google/apis/iam_v1/classes.rb', line 936 def etag @etag end |
#version ⇒ Fixnum
Deprecated.
Corresponds to the JSON property version
941 942 943 |
# File 'generated/google/apis/iam_v1/classes.rb', line 941 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
948 949 950 951 952 953 |
# File 'generated/google/apis/iam_v1/classes.rb', line 948 def update!(**args) @audit_configs = args[:audit_configs] if args.key?(:audit_configs) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @version = args[:version] if args.key?(:version) end |