package v1
- Alphabetic
- Public
- All
Type Members
-
final
case class
AuditConfigDelta(action: Action = ..., service: String = "", exemptedMember: String = "", logType: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[AuditConfigDelta] with Product with Serializable
One delta entry for AuditConfig.
One delta entry for AuditConfig. Each individual change (only one exempted_member in each entry) to a AuditConfig will be a separate entry.
- action
The action that was performed on an audit configuration in a policy. Required
- service
Specifies a service that was configured for Cloud Audit Logging. For example,
storage.googleapis.com,cloudsql.googleapis.com.allServicesis a special value that covers all services. Required- exemptedMember
A single identity that is exempted from "data access" audit logging for the
servicespecified above. Follows the same format of Binding.members.- logType
Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always enabled, and cannot be configured. Required
- Annotations
- @SerialVersionUID()
-
final
case class
Binding(role: String = "", members: Seq[String] = _root_.scala.Seq.empty, condition: Option[Expr] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Binding] with Product with Serializable
Associates
memberswith arole.Associates
memberswith arole.- role
Role that is assigned to
members. For example,roles/viewer,roles/editor, orroles/owner.- members
Specifies the identities requesting access for a Cloud Platform resource.
memberscan have the following values: *allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. *allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. *user:{emailid}: An email address that represents a specific Google account. For example,alice@example.com. *serviceAccount:{emailid}: An email address that represents a service account. For example,my-other-app@appspot.gserviceaccount.com. *group:{emailid}: An email address that represents a Google group. For example,admins@example.com. *domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example,google.comorexample.com.- condition
The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
- Annotations
- @SerialVersionUID()
-
final
case class
BindingDelta(action: Action = ..., role: String = "", member: String = "", condition: Option[Expr] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[BindingDelta] with Product with Serializable
One delta entry for Binding.
One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
- action
The action that was performed on a Binding. Required
- role
Role that is assigned to
members. For example,roles/viewer,roles/editor, orroles/owner. Required- member
A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required
- condition
The condition that is associated with this binding.
- Annotations
- @SerialVersionUID()
- final class DefaultIAMPolicyClient extends IAMPolicyClient
-
final
case class
GetIamPolicyRequest(resource: String = "", options: Option[GetPolicyOptions] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetIamPolicyRequest] with Product with Serializable
Request message for
GetIamPolicymethod.Request message for
GetIamPolicymethod.- resource
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- options
OPTIONAL: A
GetPolicyOptionsobject for specifying options toGetIamPolicy. This field is only used by Cloud IAM.
- Annotations
- @SerialVersionUID()
-
final
case class
GetPolicyOptions(requestedPolicyVersion: Int = 0, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetPolicyOptions] with Product with Serializable
Encapsulates settings provided to GetIamPolicy.
Encapsulates settings provided to GetIamPolicy.
- requestedPolicyVersion
Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
- Annotations
- @SerialVersionUID()
-
trait
IAMPolicy extends AnyRef
## API Overview Manages Identity and Access Management (IAM) policies.
## API Overview Manages Identity and Access Management (IAM) policies. Any implementation of an API that offers access control features implements the google.iam.v1.IAMPolicy interface. ## Data model Access control is applied when a principal (user or service account), takes some action on a resource exposed by a service. Resources, identified by URI-like names, are the unit of access control specification. Service implementations can choose the granularity of access control and the supported permissions for their resources. For example one database service may allow access control to be specified only at the Table level, whereas another might allow access control to also be specified at the Column level. ## Policy Structure See google.iam.v1.Policy This is intentionally not a CRUD style API because access control policies are created and deleted implicitly with the resources to which they are attached.
- trait IAMPolicyClient extends IAMPolicy with IAMPolicyClientPowerApi with AkkaGrpcClient
- trait IAMPolicyClientPowerApi extends AnyRef
-
final
case class
Policy(version: Int = 0, bindings: Seq[Binding] = _root_.scala.Seq.empty, etag: ByteString = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Policy] with Product with Serializable
Defines an Identity and Access Management (IAM) policy.
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
A
Policyis a collection ofbindings. Abindingbinds one or moremembersto a singlerole. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Aroleis a named list of permissions (defined by IAM or configured by users). Abindingcan optionally specify acondition, 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](https://cloud.google.com/iam/docs).
- 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 conditional binding 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, any version compliance checks on the incoming and/or stored policy is skipped.- bindings
Associates a list of
membersto arole. Optionally may specify aconditionthat determines when binding is in effect.bindingswith no members will result in an error.- etag
etagis 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 theetagin the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetagis returned in the response togetIamPolicy, and systems are expected to put that etag in the request tosetIamPolicyto ensure that their change will be applied to the same version of the policy. If noetagis provided in the call tosetIamPolicy, then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements.
- Annotations
- @SerialVersionUID()
- members:
-
final
case class
PolicyDelta(bindingDeltas: Seq[BindingDelta] = _root_.scala.Seq.empty, auditConfigDeltas: Seq[AuditConfigDelta] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PolicyDelta] with Product with Serializable
The difference delta between two policies.
The difference delta between two policies.
- bindingDeltas
The delta for Bindings between two policies.
- auditConfigDeltas
The delta for AuditConfigs between two policies.
- Annotations
- @SerialVersionUID()
-
final
case class
SetIamPolicyRequest(resource: String = "", policy: Option[Policy] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SetIamPolicyRequest] with Product with Serializable
Request message for
SetIamPolicymethod.Request message for
SetIamPolicymethod.- resource
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- policy
REQUIRED: The complete policy to be applied to the
resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
- Annotations
- @SerialVersionUID()
-
final
case class
TestIamPermissionsRequest(resource: String = "", permissions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TestIamPermissionsRequest] with Product with Serializable
Request message for
TestIamPermissionsmethod.Request message for
TestIamPermissionsmethod.- resource
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- permissions
The set of permissions to check for the
resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- Annotations
- @SerialVersionUID()
-
final
case class
TestIamPermissionsResponse(permissions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[TestIamPermissionsResponse] with Product with Serializable
Response message for
TestIamPermissionsmethod.Response message for
TestIamPermissionsmethod.- permissions
A subset of
TestPermissionsRequest.permissionsthat the caller is allowed.
- Annotations
- @SerialVersionUID()
Value Members
- object AuditConfigDelta extends GeneratedMessageCompanion[AuditConfigDelta] with Serializable
- object Binding extends GeneratedMessageCompanion[Binding] with Serializable
- object BindingDelta extends GeneratedMessageCompanion[BindingDelta] with Serializable
- object GetIamPolicyRequest extends GeneratedMessageCompanion[GetIamPolicyRequest] with Serializable
- object GetPolicyOptions extends GeneratedMessageCompanion[GetPolicyOptions] with Serializable
- object IAMPolicy extends ServiceDescription
- object IAMPolicyClient
-
object
IAMPolicyHandler
- Annotations
- @ApiMayChange()
- object IamPolicyProto extends GeneratedFileObject
- object OptionsProto extends GeneratedFileObject
- object Policy extends GeneratedMessageCompanion[Policy] with Serializable
- object PolicyDelta extends GeneratedMessageCompanion[PolicyDelta] with Serializable
- object PolicyProto extends GeneratedFileObject
- object SetIamPolicyRequest extends GeneratedMessageCompanion[SetIamPolicyRequest] with Serializable
- object TestIamPermissionsRequest extends GeneratedMessageCompanion[TestIamPermissionsRequest] with Serializable
- object TestIamPermissionsResponse extends GeneratedMessageCompanion[TestIamPermissionsResponse] with Serializable