Variables
AuditLogConfig_LogType_name, AuditLogConfig_LogType_value
var
(
AuditLogConfig_LogType_name
=
map
[
int32
]
string
{
0
:
"LOG_TYPE_UNSPECIFIED"
,
1
:
"ADMIN_READ"
,
2
:
"DATA_WRITE"
,
3
:
"DATA_READ"
,
}
AuditLogConfig_LogType_value
=
map
[
string
]
int32
{
"LOG_TYPE_UNSPECIFIED"
:
0
,
"ADMIN_READ"
:
1
,
"DATA_WRITE"
:
2
,
"DATA_READ"
:
3
,
}
)
Enum value maps for AuditLogConfig_LogType.
BindingDelta_Action_name, BindingDelta_Action_value
var
(
BindingDelta_Action_name
=
map
[
int32
]
string
{
0
:
"ACTION_UNSPECIFIED"
,
1
:
"ADD"
,
2
:
"REMOVE"
,
}
BindingDelta_Action_value
=
map
[
string
]
int32
{
"ACTION_UNSPECIFIED"
:
0
,
"ADD"
:
1
,
"REMOVE"
:
2
,
}
)
Enum value maps for BindingDelta_Action.
AuditConfigDelta_Action_name, AuditConfigDelta_Action_value
var
(
AuditConfigDelta_Action_name
=
map
[
int32
]
string
{
0
:
"ACTION_UNSPECIFIED"
,
1
:
"ADD"
,
2
:
"REMOVE"
,
}
AuditConfigDelta_Action_value
=
map
[
string
]
int32
{
"ACTION_UNSPECIFIED"
:
0
,
"ADD"
:
1
,
"REMOVE"
:
2
,
}
)
Enum value maps for AuditConfigDelta_Action.
File_google_iam_v1_iam_policy_proto
var
File_google_iam_v1_iam_policy_proto
protoreflect
.
FileDescriptor
File_google_iam_v1_options_proto
var
File_google_iam_v1_options_proto
protoreflect
.
FileDescriptor
File_google_iam_v1_policy_proto
var
File_google_iam_v1_policy_proto
protoreflect
.
FileDescriptor
Functions
func RegisterIAMPolicyServer
func
RegisterIAMPolicyServer
(
s
*
grpc
.
Server
,
srv
IAMPolicyServer
)
AuditConfig
type
AuditConfig
struct
{
// Specifies a service that will be enabled for audit logging.
// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
// `allServices` is a special value that covers all services.
Service
string
`protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
// The configuration for logging of each type of permission.
AuditLogConfigs
[]
*
AuditLogConfig
`protobuf:"bytes,3,rep,name=audit_log_configs,json=auditLogConfigs,proto3" json:"audit_log_configs,omitempty"`
// contains filtered or unexported fields
}
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
If there are AuditConfigs for both allServices
and a specific service,
the union of the two AuditConfigs is used for that service: the log_types
specified in each AuditConfig are enabled, and the exempted_members in each
AuditLogConfig are exempted.
Example Policy with multiple AuditConfigs:
{
"audit_configs": [
{
"service": "allServices",
"audit_log_configs": [
{
"log_type": "DATA_READ",
"exempted_members": [
"user:jose@example.com"
]
},
{
"log_type": "DATA_WRITE"
},
{
"log_type": "ADMIN_READ"
}
]
},
{
"service": "sampleservice.googleapis.com",
"audit_log_configs": [
{
"log_type": "DATA_READ"
},
{
"log_type": "DATA_WRITE",
"exempted_members": [
"user:aliya@example.com"
]
}
]
}
]
}
For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
func (*AuditConfig) Descriptor
func
(
*
AuditConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AuditConfig.ProtoReflect.Descriptor instead.
func (*AuditConfig) GetAuditLogConfigs
func
(
x
*
AuditConfig
)
GetAuditLogConfigs
()
[]
*
AuditLogConfig
func (*AuditConfig) GetService
func
(
x
*
AuditConfig
)
GetService
()
string
func (*AuditConfig) ProtoMessage
func
(
*
AuditConfig
)
ProtoMessage
()
func (*AuditConfig) ProtoReflect
func
(
x
*
AuditConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*AuditConfig) Reset
func
(
x
*
AuditConfig
)
Reset
()
func (*AuditConfig) String
func
(
x
*
AuditConfig
)
String
()
string
AuditConfigDelta
type
AuditConfigDelta
struct
{
// The action that was performed on an audit configuration in a policy.
// Required
Action
AuditConfigDelta_Action
`protobuf:"varint,1,opt,name=action,proto3,enum=google.iam.v1.AuditConfigDelta_Action" json:"action,omitempty"`
// Specifies a service that was configured for Cloud Audit Logging.
// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
// `allServices` is a special value that covers all services.
// Required
Service
string
`protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// A single identity that is exempted from "data access" audit
// logging for the `service` specified above.
// Follows the same format of Binding.members.
ExemptedMember
string
`protobuf:"bytes,3,opt,name=exempted_member,json=exemptedMember,proto3" json:"exempted_member,omitempty"`
// Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always
// enabled, and cannot be configured.
// Required
LogType
string
`protobuf:"bytes,4,opt,name=log_type,json=logType,proto3" json:"log_type,omitempty"`
// contains filtered or unexported fields
}
One delta entry for AuditConfig. Each individual change (only one exempted_member in each entry) to a AuditConfig will be a separate entry.
func (*AuditConfigDelta) Descriptor
func
(
*
AuditConfigDelta
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AuditConfigDelta.ProtoReflect.Descriptor instead.
func (*AuditConfigDelta) GetAction
func
(
x
*
AuditConfigDelta
)
GetAction
()
AuditConfigDelta_Action
func (*AuditConfigDelta) GetExemptedMember
func
(
x
*
AuditConfigDelta
)
GetExemptedMember
()
string
func (*AuditConfigDelta) GetLogType
func
(
x
*
AuditConfigDelta
)
GetLogType
()
string
func (*AuditConfigDelta) GetService
func
(
x
*
AuditConfigDelta
)
GetService
()
string
func (*AuditConfigDelta) ProtoMessage
func
(
*
AuditConfigDelta
)
ProtoMessage
()
func (*AuditConfigDelta) ProtoReflect
func
(
x
*
AuditConfigDelta
)
ProtoReflect
()
protoreflect
.
Message
func (*AuditConfigDelta) Reset
func
(
x
*
AuditConfigDelta
)
Reset
()
func (*AuditConfigDelta) String
func
(
x
*
AuditConfigDelta
)
String
()
string
AuditConfigDelta_Action
type
AuditConfigDelta_Action
int32
The type of action performed on an audit configuration in a policy.
AuditConfigDelta_ACTION_UNSPECIFIED, AuditConfigDelta_ADD, AuditConfigDelta_REMOVE
const
(
// Unspecified.
AuditConfigDelta_ACTION_UNSPECIFIED
AuditConfigDelta_Action
=
0
// Addition of an audit configuration.
AuditConfigDelta_ADD
AuditConfigDelta_Action
=
1
// Removal of an audit configuration.
AuditConfigDelta_REMOVE
AuditConfigDelta_Action
=
2
)
func (AuditConfigDelta_Action) Descriptor
func
(
AuditConfigDelta_Action
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (AuditConfigDelta_Action) Enum
func
(
x
AuditConfigDelta_Action
)
Enum
()
*
AuditConfigDelta_Action
func (AuditConfigDelta_Action) EnumDescriptor
func
(
AuditConfigDelta_Action
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AuditConfigDelta_Action.Descriptor instead.
func (AuditConfigDelta_Action) Number
func
(
x
AuditConfigDelta_Action
)
Number
()
protoreflect
.
EnumNumber
func (AuditConfigDelta_Action) String
func
(
x
AuditConfigDelta_Action
)
String
()
string
func (AuditConfigDelta_Action) Type
func
(
AuditConfigDelta_Action
)
Type
()
protoreflect
.
EnumType
AuditLogConfig
type
AuditLogConfig
struct
{
// The log type that this config enables.
LogType
AuditLogConfig_LogType
`protobuf:"varint,1,opt,name=log_type,json=logType,proto3,enum=google.iam.v1.AuditLogConfig_LogType" json:"log_type,omitempty"`
// Specifies the identities that do not cause logging for this type of
// permission.
// Follows the same format of [Binding.members][google.iam.v1.Binding.members].
ExemptedMembers
[]
string
`protobuf:"bytes,2,rep,name=exempted_members,json=exemptedMembers,proto3" json:"exempted_members,omitempty"`
// contains filtered or unexported fields
}
Provides the configuration for logging a type of permissions. Example:
{
"audit_log_configs": [
{
"log_type": "DATA_READ",
"exempted_members": [
"user:jose@example.com"
]
},
{
"log_type": "DATA_WRITE"
}
]
}
This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
func (*AuditLogConfig) Descriptor
func
(
*
AuditLogConfig
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AuditLogConfig.ProtoReflect.Descriptor instead.
func (*AuditLogConfig) GetExemptedMembers
func
(
x
*
AuditLogConfig
)
GetExemptedMembers
()
[]
string
func (*AuditLogConfig) GetLogType
func
(
x
*
AuditLogConfig
)
GetLogType
()
AuditLogConfig_LogType
func (*AuditLogConfig) ProtoMessage
func
(
*
AuditLogConfig
)
ProtoMessage
()
func (*AuditLogConfig) ProtoReflect
func
(
x
*
AuditLogConfig
)
ProtoReflect
()
protoreflect
.
Message
func (*AuditLogConfig) Reset
func
(
x
*
AuditLogConfig
)
Reset
()
func (*AuditLogConfig) String
func
(
x
*
AuditLogConfig
)
String
()
string
AuditLogConfig_LogType
type
AuditLogConfig_LogType
int32
The list of valid permission types for which logging can be configured. Admin writes are always logged, and are not configurable.
AuditLogConfig_LOG_TYPE_UNSPECIFIED, AuditLogConfig_ADMIN_READ, AuditLogConfig_DATA_WRITE, AuditLogConfig_DATA_READ
const
(
// Default case. Should never be this.
AuditLogConfig_LOG_TYPE_UNSPECIFIED
AuditLogConfig_LogType
=
0
// Admin reads. Example: CloudIAM getIamPolicy
AuditLogConfig_ADMIN_READ
AuditLogConfig_LogType
=
1
// Data writes. Example: CloudSQL Users create
AuditLogConfig_DATA_WRITE
AuditLogConfig_LogType
=
2
// Data reads. Example: CloudSQL Users list
AuditLogConfig_DATA_READ
AuditLogConfig_LogType
=
3
)
func (AuditLogConfig_LogType) Descriptor
func
(
AuditLogConfig_LogType
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (AuditLogConfig_LogType) Enum
func
(
x
AuditLogConfig_LogType
)
Enum
()
*
AuditLogConfig_LogType
func (AuditLogConfig_LogType) EnumDescriptor
func
(
AuditLogConfig_LogType
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use AuditLogConfig_LogType.Descriptor instead.
func (AuditLogConfig_LogType) Number
func
(
x
AuditLogConfig_LogType
)
Number
()
protoreflect
.
EnumNumber
func (AuditLogConfig_LogType) String
func
(
x
AuditLogConfig_LogType
)
String
()
string
func (AuditLogConfig_LogType) Type
func
(
AuditLogConfig_LogType
)
Type
()
protoreflect
.
EnumType
Binding
type
Binding
struct
{
// Role that is assigned to the list of `members`, or principals.
// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Role
string
`protobuf:"bytes,1,opt,name=role,proto3" json:"role,omitempty"`
// Specifies the principals requesting access for a Cloud Platform resource.
// `members` can 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`.
//
// - `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
// identifier) representing a user that has been recently deleted. For
// example, `alice@example.com?uid=123456789012345678901`. If the user is
// recovered, this value reverts to `user:{emailid}` and the recovered user
// retains the role in the binding.
//
// - `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
// unique identifier) representing a service account that has been recently
// deleted. For example,
// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
// If the service account is undeleted, this value reverts to
// `serviceAccount:{emailid}` and the undeleted service account retains the
// role in the binding.
//
// - `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
// identifier) representing a Google group that has been recently
// deleted. For example, `admins@example.com?uid=123456789012345678901`. If
// the group is recovered, this value reverts to `group:{emailid}` and the
// recovered group retains the role in the binding.
//
// - `domain:{domain}`: The G Suite domain (primary) that represents all the
// users of that domain. For example, `google.com` or `example.com`.
Members
[]
string
`protobuf:"bytes,2,rep,name=members,proto3" json:"members,omitempty"`
// The condition that is associated with this binding.
//
// If the condition evaluates to `true`, then this binding applies to the
// current request.
//
// If the condition evaluates to `false`, then this binding does not apply to
// the current request. However, a different role binding might grant the same
// role to one or more of the principals in this binding.
//
// To learn which resources support conditions in their IAM policies, see the
// [IAM
// documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Condition
*
expr
.
Expr
`protobuf:"bytes,3,opt,name=condition,proto3" json:"condition,omitempty"`
// contains filtered or unexported fields
}
Associates members
, or principals, with a role
.
func (*Binding) Descriptor
Deprecated: Use Binding.ProtoReflect.Descriptor instead.
func (*Binding) GetCondition
func (*Binding) GetMembers
func (*Binding) GetRole
func (*Binding) ProtoMessage
func
(
*
Binding
)
ProtoMessage
()
func (*Binding) ProtoReflect
func
(
x
*
Binding
)
ProtoReflect
()
protoreflect
.
Message
func (*Binding) Reset
func
(
x
*
Binding
)
Reset
()
func (*Binding) String
BindingDelta
type
BindingDelta
struct
{
// The action that was performed on a Binding.
// Required
Action
BindingDelta_Action
`protobuf:"varint,1,opt,name=action,proto3,enum=google.iam.v1.BindingDelta_Action" json:"action,omitempty"`
// Role that is assigned to `members`.
// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
// Required
Role
string
`protobuf:"bytes,2,opt,name=role,proto3" json:"role,omitempty"`
// A single identity requesting access for a Cloud Platform resource.
// Follows the same format of Binding.members.
// Required
Member
string
`protobuf:"bytes,3,opt,name=member,proto3" json:"member,omitempty"`
// The condition that is associated with this binding.
Condition
*
expr
.
Expr
`protobuf:"bytes,4,opt,name=condition,proto3" json:"condition,omitempty"`
// contains filtered or unexported fields
}
One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
func (*BindingDelta) Descriptor
func
(
*
BindingDelta
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use BindingDelta.ProtoReflect.Descriptor instead.
func (*BindingDelta) GetAction
func
(
x
*
BindingDelta
)
GetAction
()
BindingDelta_Action
func (*BindingDelta) GetCondition
func
(
x
*
BindingDelta
)
GetCondition
()
*
expr
.
Expr
func (*BindingDelta) GetMember
func
(
x
*
BindingDelta
)
GetMember
()
string
func (*BindingDelta) GetRole
func
(
x
*
BindingDelta
)
GetRole
()
string
func (*BindingDelta) ProtoMessage
func
(
*
BindingDelta
)
ProtoMessage
()
func (*BindingDelta) ProtoReflect
func
(
x
*
BindingDelta
)
ProtoReflect
()
protoreflect
.
Message
func (*BindingDelta) Reset
func
(
x
*
BindingDelta
)
Reset
()
func (*BindingDelta) String
func
(
x
*
BindingDelta
)
String
()
string
BindingDelta_Action
type
BindingDelta_Action
int32
The type of action performed on a Binding in a policy.
BindingDelta_ACTION_UNSPECIFIED, BindingDelta_ADD, BindingDelta_REMOVE
const
(
// Unspecified.
BindingDelta_ACTION_UNSPECIFIED
BindingDelta_Action
=
0
// Addition of a Binding.
BindingDelta_ADD
BindingDelta_Action
=
1
// Removal of a Binding.
BindingDelta_REMOVE
BindingDelta_Action
=
2
)
func (BindingDelta_Action) Descriptor
func
(
BindingDelta_Action
)
Descriptor
()
protoreflect
.
EnumDescriptor
func (BindingDelta_Action) Enum
func
(
x
BindingDelta_Action
)
Enum
()
*
BindingDelta_Action
func (BindingDelta_Action) EnumDescriptor
func
(
BindingDelta_Action
)
EnumDescriptor
()
([]
byte
,
[]
int
)
Deprecated: Use BindingDelta_Action.Descriptor instead.
func (BindingDelta_Action) Number
func
(
x
BindingDelta_Action
)
Number
()
protoreflect
.
EnumNumber
func (BindingDelta_Action) String
func
(
x
BindingDelta_Action
)
String
()
string
func (BindingDelta_Action) Type
func
(
BindingDelta_Action
)
Type
()
protoreflect
.
EnumType
GetIamPolicyRequest
type
GetIamPolicyRequest
struct
{
// REQUIRED: The resource for which the policy is being requested.
// See the operation documentation for the appropriate value for this field.
Resource
string
`protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// OPTIONAL: A `GetPolicyOptions` object for specifying options to
// `GetIamPolicy`.
Options
*
GetPolicyOptions
`protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
// contains filtered or unexported fields
}
Request message for GetIamPolicy
method.
func (*GetIamPolicyRequest) Descriptor
func
(
*
GetIamPolicyRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GetIamPolicyRequest.ProtoReflect.Descriptor instead.
func (*GetIamPolicyRequest) GetOptions
func
(
x
*
GetIamPolicyRequest
)
GetOptions
()
*
GetPolicyOptions
func (*GetIamPolicyRequest) GetResource
func
(
x
*
GetIamPolicyRequest
)
GetResource
()
string
func (*GetIamPolicyRequest) ProtoMessage
func
(
*
GetIamPolicyRequest
)
ProtoMessage
()
func (*GetIamPolicyRequest) ProtoReflect
func
(
x
*
GetIamPolicyRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*GetIamPolicyRequest) Reset
func
(
x
*
GetIamPolicyRequest
)
Reset
()
func (*GetIamPolicyRequest) String
func
(
x
*
GetIamPolicyRequest
)
String
()
string
GetPolicyOptions
type
GetPolicyOptions
struct
{
RequestedPolicyVersion
int32
""
/* 130 byte string literal not displayed */
}
Encapsulates settings provided to GetIamPolicy.
func (*GetPolicyOptions) Descriptor
func
(
*
GetPolicyOptions
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use GetPolicyOptions.ProtoReflect.Descriptor instead.
func (*GetPolicyOptions) GetRequestedPolicyVersion
func
(
x
*
GetPolicyOptions
)
GetRequestedPolicyVersion
()
int32
func (*GetPolicyOptions) ProtoMessage
func
(
*
GetPolicyOptions
)
ProtoMessage
()
func (*GetPolicyOptions) ProtoReflect
func
(
x
*
GetPolicyOptions
)
ProtoReflect
()
protoreflect
.
Message
func (*GetPolicyOptions) Reset
func
(
x
*
GetPolicyOptions
)
Reset
()
func (*GetPolicyOptions) String
func
(
x
*
GetPolicyOptions
)
String
()
string
IAMPolicyClient
type
IAMPolicyClient
interface
{
// Sets the access control policy on the specified resource. Replaces any
// existing policy.
//
// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
SetIamPolicy
(
ctx
context
.
Context
,
in
*
SetIamPolicyRequest
,
opts
...
grpc
.
CallOption
)
(
*
Policy
,
error
)
// Gets the access control policy for a resource.
// Returns an empty policy if the resource exists and does not have a policy
// set.
GetIamPolicy
(
ctx
context
.
Context
,
in
*
GetIamPolicyRequest
,
opts
...
grpc
.
CallOption
)
(
*
Policy
,
error
)
// Returns permissions that a caller has on the specified resource.
// If the resource does not exist, this will return an empty set of
// permissions, not a `NOT_FOUND` error.
//
// Note: This operation is designed to be used for building permission-aware
// UIs and command-line tools, not for authorization checking. This operation
// may "fail open" without warning.
TestIamPermissions
(
ctx
context
.
Context
,
in
*
TestIamPermissionsRequest
,
opts
...
grpc
.
CallOption
)
(
*
TestIamPermissionsResponse
,
error
)
}
IAMPolicyClient is the client API for IAMPolicy service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream .
func NewIAMPolicyClient
func
NewIAMPolicyClient
(
cc
grpc
.
ClientConnInterface
)
IAMPolicyClient
IAMPolicyServer
type
IAMPolicyServer
interface
{
// Sets the access control policy on the specified resource. Replaces any
// existing policy.
//
// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
SetIamPolicy
(
context
.
Context
,
*
SetIamPolicyRequest
)
(
*
Policy
,
error
)
// Gets the access control policy for a resource.
// Returns an empty policy if the resource exists and does not have a policy
// set.
GetIamPolicy
(
context
.
Context
,
*
GetIamPolicyRequest
)
(
*
Policy
,
error
)
// Returns permissions that a caller has on the specified resource.
// If the resource does not exist, this will return an empty set of
// permissions, not a `NOT_FOUND` error.
//
// Note: This operation is designed to be used for building permission-aware
// UIs and command-line tools, not for authorization checking. This operation
// may "fail open" without warning.
TestIamPermissions
(
context
.
Context
,
*
TestIamPermissionsRequest
)
(
*
TestIamPermissionsResponse
,
error
)
}
IAMPolicyServer is the server API for IAMPolicy service.
Policy
type
Policy
struct
{
// Specifies the format of the policy.
//
// Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
// are rejected.
//
// Any operation that affects conditional role bindings must specify version
// `3`. This requirement applies to the following operations:
//
// - Getting a policy that includes a conditional role binding
// - Adding a conditional role binding to a policy
// - Changing a conditional role binding in a policy
// - Removing any role binding, with or without a condition, from a policy
// that includes conditions
//
// **Important:** If you use IAM Conditions, you must include the `etag` field
// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
// you to overwrite a version `3` policy with a version `1` policy, and all of
// the conditions in the version `3` policy are lost.
//
// If a policy does not include any conditions, operations on that policy may
// specify any valid version or leave the field unset.
//
// To learn which resources support conditions in their IAM policies, see the
// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Version
int32
`protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
// Associates a list of `members`, or principals, with a `role`. Optionally,
// may specify a `condition` that determines how and when the `bindings` are
// applied. Each of the `bindings` must contain at least one principal.
//
// The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
// of these principals can be Google groups. Each occurrence of a principal
// counts towards these limits. For example, if the `bindings` grant 50
// different roles to `user:alice@example.com`, and not to any other
// principal, then you can add another 1,450 principals to the `bindings` in
// the `Policy`.
Bindings
[]
*
Binding
`protobuf:"bytes,4,rep,name=bindings,proto3" json:"bindings,omitempty"`
// Specifies cloud audit logging configuration for this policy.
AuditConfigs
[]
*
AuditConfig
`protobuf:"bytes,6,rep,name=audit_configs,json=auditConfigs,proto3" json:"audit_configs,omitempty"`
// `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.
//
// **Important:** If you use IAM Conditions, you must include the `etag` field
// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
// you to overwrite a version `3` policy with a version `1` policy, and all of
// the conditions in the version `3` policy are lost.
Etag
[]
byte
`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
A Policy
is a collection of bindings
. A binding
binds one or more members
, or principals, to a single role
. Principals can be user
accounts, service accounts, Google groups, and domains (such as G Suite). A role
is a named list of permissions; each role
can be an IAM predefined
role or a user-created custom role.
For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical expression that allows access to a resource
only if the expression evaluates to true
. A condition can add constraints
based on attributes of the request, the resource, or both. To learn which
resources support conditions in their IAM policies, see the IAM documentation
.
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')",
}
}
],
"etag": "BwWWja0YfJA=",
"version": 3
}
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')
etag: BwWWja0YfJA=
version: 3
For a description of IAM and its features, see the IAM documentation .
func (*Policy) Descriptor
Deprecated: Use Policy.ProtoReflect.Descriptor instead.
func (*Policy) GetAuditConfigs
func
(
x
*
Policy
)
GetAuditConfigs
()
[]
*
AuditConfig
func (*Policy) GetBindings
func (*Policy) GetEtag
func (*Policy) GetVersion
func (*Policy) ProtoMessage
func
(
*
Policy
)
ProtoMessage
()
func (*Policy) ProtoReflect
func
(
x
*
Policy
)
ProtoReflect
()
protoreflect
.
Message
func (*Policy) Reset
func
(
x
*
Policy
)
Reset
()
func (*Policy) String
PolicyDelta
type
PolicyDelta
struct
{
// The delta for Bindings between two policies.
BindingDeltas
[]
*
BindingDelta
`protobuf:"bytes,1,rep,name=binding_deltas,json=bindingDeltas,proto3" json:"binding_deltas,omitempty"`
// The delta for AuditConfigs between two policies.
AuditConfigDeltas
[]
*
AuditConfigDelta
`protobuf:"bytes,2,rep,name=audit_config_deltas,json=auditConfigDeltas,proto3" json:"audit_config_deltas,omitempty"`
// contains filtered or unexported fields
}
The difference delta between two policies.
func (*PolicyDelta) Descriptor
func
(
*
PolicyDelta
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use PolicyDelta.ProtoReflect.Descriptor instead.
func (*PolicyDelta) GetAuditConfigDeltas
func
(
x
*
PolicyDelta
)
GetAuditConfigDeltas
()
[]
*
AuditConfigDelta
func (*PolicyDelta) GetBindingDeltas
func
(
x
*
PolicyDelta
)
GetBindingDeltas
()
[]
*
BindingDelta
func (*PolicyDelta) ProtoMessage
func
(
*
PolicyDelta
)
ProtoMessage
()
func (*PolicyDelta) ProtoReflect
func
(
x
*
PolicyDelta
)
ProtoReflect
()
protoreflect
.
Message
func (*PolicyDelta) Reset
func
(
x
*
PolicyDelta
)
Reset
()
func (*PolicyDelta) String
func
(
x
*
PolicyDelta
)
String
()
string
SetIamPolicyRequest
type
SetIamPolicyRequest
struct
{
// REQUIRED: The resource for which the policy is being specified.
// See the operation documentation for the appropriate value for this field.
Resource
string
`protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// 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.
Policy
*
Policy
`protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`
// OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
// the fields in the mask will be modified. If no mask is provided, the
// following default mask is used:
//
// `paths: "bindings, etag"`
UpdateMask
*
fieldmaskpb
.
FieldMask
`protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
Request message for SetIamPolicy
method.
func (*SetIamPolicyRequest) Descriptor
func
(
*
SetIamPolicyRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use SetIamPolicyRequest.ProtoReflect.Descriptor instead.
func (*SetIamPolicyRequest) GetPolicy
func
(
x
*
SetIamPolicyRequest
)
GetPolicy
()
*
Policy
func (*SetIamPolicyRequest) GetResource
func
(
x
*
SetIamPolicyRequest
)
GetResource
()
string
func (*SetIamPolicyRequest) GetUpdateMask
func
(
x
*
SetIamPolicyRequest
)
GetUpdateMask
()
*
fieldmaskpb
.
FieldMask
func (*SetIamPolicyRequest) ProtoMessage
func
(
*
SetIamPolicyRequest
)
ProtoMessage
()
func (*SetIamPolicyRequest) ProtoReflect
func
(
x
*
SetIamPolicyRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*SetIamPolicyRequest) Reset
func
(
x
*
SetIamPolicyRequest
)
Reset
()
func (*SetIamPolicyRequest) String
func
(
x
*
SetIamPolicyRequest
)
String
()
string
TestIamPermissionsRequest
type
TestIamPermissionsRequest
struct
{
// REQUIRED: The resource for which the policy detail is being requested.
// See the operation documentation for the appropriate value for this field.
Resource
string
`protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// 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).
Permissions
[]
string
`protobuf:"bytes,2,rep,name=permissions,proto3" json:"permissions,omitempty"`
// contains filtered or unexported fields
}
Request message for TestIamPermissions
method.
func (*TestIamPermissionsRequest) Descriptor
func
(
*
TestIamPermissionsRequest
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use TestIamPermissionsRequest.ProtoReflect.Descriptor instead.
func (*TestIamPermissionsRequest) GetPermissions
func
(
x
*
TestIamPermissionsRequest
)
GetPermissions
()
[]
string
func (*TestIamPermissionsRequest) GetResource
func
(
x
*
TestIamPermissionsRequest
)
GetResource
()
string
func (*TestIamPermissionsRequest) ProtoMessage
func
(
*
TestIamPermissionsRequest
)
ProtoMessage
()
func (*TestIamPermissionsRequest) ProtoReflect
func
(
x
*
TestIamPermissionsRequest
)
ProtoReflect
()
protoreflect
.
Message
func (*TestIamPermissionsRequest) Reset
func
(
x
*
TestIamPermissionsRequest
)
Reset
()
func (*TestIamPermissionsRequest) String
func
(
x
*
TestIamPermissionsRequest
)
String
()
string
TestIamPermissionsResponse
type
TestIamPermissionsResponse
struct
{
// A subset of `TestPermissionsRequest.permissions` that the caller is
// allowed.
Permissions
[]
string
`protobuf:"bytes,1,rep,name=permissions,proto3" json:"permissions,omitempty"`
// contains filtered or unexported fields
}
Response message for TestIamPermissions
method.
func (*TestIamPermissionsResponse) Descriptor
func
(
*
TestIamPermissionsResponse
)
Descriptor
()
([]
byte
,
[]
int
)
Deprecated: Use TestIamPermissionsResponse.ProtoReflect.Descriptor instead.
func (*TestIamPermissionsResponse) GetPermissions
func
(
x
*
TestIamPermissionsResponse
)
GetPermissions
()
[]
string
func (*TestIamPermissionsResponse) ProtoMessage
func
(
*
TestIamPermissionsResponse
)
ProtoMessage
()
func (*TestIamPermissionsResponse) ProtoReflect
func
(
x
*
TestIamPermissionsResponse
)
ProtoReflect
()
protoreflect
.
Message
func (*TestIamPermissionsResponse) Reset
func
(
x
*
TestIamPermissionsResponse
)
Reset
()
func (*TestIamPermissionsResponse) String
func
(
x
*
TestIamPermissionsResponse
)
String
()
string
UnimplementedIAMPolicyServer
type
UnimplementedIAMPolicyServer
struct
{
}
UnimplementedIAMPolicyServer can be embedded to have forward compatible implementations.
func (*UnimplementedIAMPolicyServer) GetIamPolicy
func
(
*
UnimplementedIAMPolicyServer
)
GetIamPolicy
(
context
.
Context
,
*
GetIamPolicyRequest
)
(
*
Policy
,
error
)
func (*UnimplementedIAMPolicyServer) SetIamPolicy
func
(
*
UnimplementedIAMPolicyServer
)
SetIamPolicy
(
context
.
Context
,
*
SetIamPolicyRequest
)
(
*
Policy
,
error
)
func (*UnimplementedIAMPolicyServer) TestIamPermissions
func
(
*
UnimplementedIAMPolicyServer
)
TestIamPermissions
(
context
.
Context
,
*
TestIamPermissionsRequest
)
(
*
TestIamPermissionsResponse
,
error
)
