Package google.iam.v3

Index

AccessPolicies

Manages Identity and Access Management (IAM) Unified Access Policies.

CreateAccessPolicy

rpc CreateAccessPolicy(CreateAccessPolicyRequest) returns (Operation)

Creates a Unified Access Policy, and returns a long running operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

DeleteAccessPolicy

rpc DeleteAccessPolicy(DeleteAccessPolicyRequest) returns (Operation)

Deletes a Unified Access Policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

GetAccessPolicy

rpc GetAccessPolicy(GetAccessPolicyRequest) returns (AccessPolicy)

Gets a Unified Access Policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

ListAccessPolicies

rpc ListAccessPolicies(ListAccessPoliciesRequest) returns (ListAccessPoliciesResponse)

Lists Unified Access Policies.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

SearchAccessPolicyBindings

rpc SearchAccessPolicyBindings(SearchAccessPolicyBindingsRequest) returns (SearchAccessPolicyBindingsResponse)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

UpdateAccessPolicy

rpc UpdateAccessPolicy(UpdateAccessPolicyRequest) returns (Operation)

Updates a Unified Access Policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

PolicyBindings

An interface for managing Identity and Access Management (IAM) policy bindings.

CreatePolicyBinding

rpc CreatePolicyBinding(CreatePolicyBindingRequest) returns (Operation)

Creates a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is created, the policy is applied to the target.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

DeletePolicyBinding

rpc DeletePolicyBinding(DeletePolicyBindingRequest) returns (Operation)

Deletes a policy binding and returns a long-running operation. Callers will need the IAM permissions on both the policy and target. After the binding is deleted, the policy no longer applies to the target.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

GetPolicyBinding

rpc GetPolicyBinding(GetPolicyBindingRequest) returns (PolicyBinding)

Gets a policy binding.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • iam.policybindings.get

For more information, see the IAM documentation.

ListPolicyBindings

rpc ListPolicyBindings(ListPolicyBindingsRequest) returns (ListPolicyBindingsResponse)

Lists policy bindings.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • iam.policybindings.list

For more information, see the IAM documentation.

SearchTargetPolicyBindings

rpc SearchTargetPolicyBindings(SearchTargetPolicyBindingsRequest) returns (SearchTargetPolicyBindingsResponse)

Search policy bindings by target. Returns all policy binding objects bound directly to target.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

UpdatePolicyBinding

rpc UpdatePolicyBinding(UpdatePolicyBindingRequest) returns (Operation)

Updates a policy binding and returns a long-running operation. Callers will need the IAM permissions on the policy and target in the binding to update. Target and policy are immutable and cannot be updated.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

PrincipalAccessBoundaryPolicies

Manages Identity and Access Management (IAM) principal access boundary policies.

CreatePrincipalAccessBoundaryPolicy

rpc CreatePrincipalAccessBoundaryPolicy(CreatePrincipalAccessBoundaryPolicyRequest) returns (Operation)

Creates a principal access boundary policy, and returns a long running operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • iam.principalaccessboundarypolicies.create

For more information, see the IAM documentation.

DeletePrincipalAccessBoundaryPolicy

rpc DeletePrincipalAccessBoundaryPolicy(DeletePrincipalAccessBoundaryPolicyRequest) returns (Operation)

Deletes a principal access boundary policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • iam.principalaccessboundarypolicies.delete

For more information, see the IAM documentation.

GetPrincipalAccessBoundaryPolicy

rpc GetPrincipalAccessBoundaryPolicy(GetPrincipalAccessBoundaryPolicyRequest) returns (PrincipalAccessBoundaryPolicy)

Gets a principal access boundary policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • iam.principalaccessboundarypolicies.get

For more information, see the IAM documentation.

ListPrincipalAccessBoundaryPolicies

rpc ListPrincipalAccessBoundaryPolicies(ListPrincipalAccessBoundaryPoliciesRequest) returns (ListPrincipalAccessBoundaryPoliciesResponse)

Lists principal access boundary policies.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • iam.principalaccessboundarypolicies.list

For more information, see the IAM documentation.

SearchPrincipalAccessBoundaryPolicyBindings

rpc SearchPrincipalAccessBoundaryPolicyBindings(SearchPrincipalAccessBoundaryPolicyBindingsRequest) returns (SearchPrincipalAccessBoundaryPolicyBindingsResponse)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • iam.principalaccessboundarypolicies.searchPolicyBindings

For more information, see the IAM documentation.

UpdatePrincipalAccessBoundaryPolicy

rpc UpdatePrincipalAccessBoundaryPolicy(UpdatePrincipalAccessBoundaryPolicyRequest) returns (Operation)

Updates a principal access boundary policy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/iam

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • iam.principalaccessboundarypolicies.update

For more information, see the IAM documentation.

AccessPolicy

An IAM Unified Access Policy resource.

Fields
name

string

Identifier. The resource name of the Unified Access Policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{unified_access_policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{unified_access_policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{unified_access_policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{unified_access_policy_id}
uid

string

Output only. The globally unique ID of the Unified Access Policy.

etag

string

Optional. The etag for the Unified Access Policy. If this is provided on update, it must match the server's etag.

display_name

string

Optional. The description of the Unified Access Policy. This description can be a maximum of 63 characters.

annotations

map<string, string>

Optional. User-defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations.

create_time

Timestamp

Output only. The time when the Unified Access Policy was created.

update_time

Timestamp

Output only. The time when the Unified Access Policy was most recently updated.

details

AccessPolicyDetails

Optional. The details for the Unified Access Policy.

AccessPolicyDetails

Unified Access Policy details.

Fields
rules[]

AccessPolicyRule

Required. A list of Unified Access Policy rules.

AccessPolicyRule

Unified Access Policy rule that determines the behavior of the policy.

Fields
principals[]

string

Required. The principals to include in the rule. This field can contain the following values:

  • principal://goog/subject/{email_id}: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, principal://goog/subject/alice@example.com.

  • principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}: A Google Cloud service account. For example, principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com.

  • principalSet://goog/group/{group_id}: A Google group. For example, principalSet://goog/group/admins@example.com.

  • principalSet://goog/cloudIdentityCustomerId/{customer_id}: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, principalSet://goog/cloudIdentityCustomerId/C01Abc35.

  • principalSet://goog/public:all: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. This value is only supported in rules with the DENY effect.

  • principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool.

  • principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group.

  • principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value.

  • principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool.

  • principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool.

  • principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group.

  • principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute.

  • principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool.

  • principal://{trust_domain}/{agent_resource_path}/{agent_id}: A single, specific agent identity.

  • principalSet://{trust_domain}/*: All agent identities that belong to a particular trust domain.

  • principalSet://{trust_domain}/attribute.{attribute_name}/{attribute_value}: All agents with a particular attribute.

If an identifier that was previously used in a rule is soft deleted, then a deleted prefix is automatically added to the identifier. Users can't add new identifiers with this syntax.

  • deleted:principal://goog/subject/{email_id}?uid={uid}: A specific Google Account that was deleted recently. For example, deleted:principal://goog/subject/alice@example.com?uid=1234567890. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account.

  • deleted:principalSet://goog/group/{group_id}?uid={uid}: A Google group that was deleted recently. For example, deleted:principalSet://goog/group/admins@example.com?uid=1234567890. If the Google group is restored, this identifier reverts to the standard identifier for a Google group.

  • deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}: A Google Cloud service account that was deleted recently. For example, deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890. If the service account is undeleted, this identifier reverts to the standard identifier for a service account.

  • deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A workforce identity that was deleted recently. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value. If the workforce identity is undeleted, this identifier reverts to the standard identifier for a workforce identity.

excluded_principals[]

string

Optional. The principals to exclude from the rule, even if they are listed in the principals. For example, you could add a Google group to the principals, then exclude specific users who belong to that group.

operation

Operation

Required. Attributes that are used to determine whether this rule applies to a request.

conditions

map<string, Expr>

Optional. The conditions that determine whether this rule applies to a request. Conditions are identified by their key, which is the FQDN of the service that they are relevant to. For example:

"conditions": {
 "iam.googleapis.com": {
  "expression": {cel_expression}
 }
}

Each rule is evaluated independently. If this rule does not apply to a request, other rules might still apply. The following keys are supported:

  • eventarc.googleapis.com: Can use CEL functions that evaluate resource fields.

  • iam.googleapis.com: Can use CEL functions that evaluate resource tags and combine them using boolean and logical operators. Other functions and operators are not supported.

  • iap.googleapis.com: Can use CEL functions and attributes that evaluate destination resources for requests that use the iap.googleapis.com/resources.egressViaIAP permission.

description

string

Optional. Customer-specified description of the rule. This description can be a maximum of 256 characters.

effect

Effect

Required. The effect of the rule.

Effect

An effect to describe how the rule affects access.

Enums
EFFECT_UNSPECIFIED The effect is unspecified.
DENY The rule will deny access if it evaluates to true.
ALLOW The rule will grant access if it evaluates to true.

Operation

Attributes that are used to determine whether this rule applies to a request.

Fields
permissions[]

string

Optional. The permissions to include in the rule. Rules with the ALLOW effect grant the specified permissions. Rules with the DENY effect deny the specified permissions.

The following formats are supported:

  • Individual permissions: Individual permissions use the format {service_fqdn}/{resource}.{verb}, where {service_fqdn} is the fully qualified domain name for the service. For example, eventarc.googleapis.com/messageBuses.publish.
  • Roles: Only supported in rules with the ALLOW effect. Roles use the format role:{role_name}. For example, role:roles/logging.logsViewer. If you include a role name in a rule, then the rule includes all of the permissions in that role.
  • Permission groups: Sets of permissions, such as aiplatform.googleapis.com/*.*. Permission groups are sets of permissions that match a specified pattern. There are some restrictions on the permission groups you can reference and the permissions included in those groups. For more information, see Permission groups.

An empty list doesn't match any permissions.

excluded_permissions[]

string

Optional. Specifies the permissions to exclude from the rule. If a permission appears in permissions and in excluded_permissions, then it will not be subject to the rule effect.

The excluded permissions can be specified using the same syntax as permissions.

CreateAccessPolicyRequest

Request message for CreateAccessPolicy method.

Fields
parent

string

Required. The parent resource where this Unified Access Policy is created.

Format: * projects/{project_id}/locations/{location} * projects/{project_number}/locations/{location} * folders/{folder_id}/locations/{location} * organizations/{organization_id}/locations/{location}

access_policy_id

string

Required. The ID to use for the Unified Access Policy, which will become the final component of the Unified Access Policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots (/[a-z][a-z0-9-.]{2,62}/).

This value must be unique among all Unified Access Policies with the same parent.

access_policy

AccessPolicy

Required. The Unified Access Policy to create.

validate_only

bool

Optional. If set, validate the request and preview the creation, but do not actually post it.

CreatePolicyBindingRequest

Request message for CreatePolicyBinding method.

Fields
parent

string

Required. The parent resource where this policy binding will be created. The binding parent is the closest Resource Manager resource (project, folder or organization) to the binding target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
policy_binding_id

string

Required. The ID to use for the policy binding, which will become the final component of the policy binding's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

policy_binding

PolicyBinding

Required. The policy binding to create.

validate_only

bool

Optional. If set, validate the request and preview the creation, but do not actually post it.

CreatePrincipalAccessBoundaryPolicyRequest

Request message for CreatePrincipalAccessBoundaryPolicyRequest method.

Fields
parent

string

Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported.

Format: organizations/{organization_id}/locations/{location}

principal_access_boundary_policy_id

string

Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /[a-z][a-z0-9-.]{2,62}/.

principal_access_boundary_policy

PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to create.

validate_only

bool

Optional. If set, validate the request and preview the creation, but do not actually post it.

DeleteAccessPolicyRequest

Request message for DeleteAccessPolicy method.

Fields
name

string

Required. The name of the Unified Access Policy to delete.

Format: * projects/{project_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * projects/{project_number}/locations/{location}/accessPolicies/{unified_access_policy_id} * folders/{folder_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * organizations/{organization_id}/locations/{location}/accessPolicies/{unified_access_policy_id}

etag

string

Optional. The etag of the Unified Access Policy. If this is provided, it must match the server's etag.

validate_only

bool

Optional. If set, validate the request and preview the deletion, but do not actually post it.

force

bool

Optional. If set to true, the request will force the deletion of the Unified Access Policy even if it's referenced in existing bindings. If this value is set to false and the Unified Access Policy is referenced in existing bindings, then the request fails.

DeletePolicyBindingRequest

Request message for DeletePolicyBinding method.

Fields
name

string

Required. The name of the policy binding to delete.

Format:

  • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
  • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
  • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
  • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
etag

string

Optional. The etag of the policy binding. If this is provided, it must match the server's etag.

validate_only

bool

Optional. If set, validate the request and preview the deletion, but do not actually post it.

DeletePrincipalAccessBoundaryPolicyRequest

Request message for DeletePrincipalAccessBoundaryPolicy method.

Fields
name

string

Required. The name of the principal access boundary policy to delete.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

etag

string

Optional. The etag of the principal access boundary policy. If this is provided, it must match the server's etag.

validate_only

bool

Optional. If set, validate the request and preview the deletion, but do not actually post it.

force

bool

Optional. If set to true, the request will force the deletion of the policy even if the policy is referenced in policy bindings.

GetAccessPolicyRequest

Request message for GetAccessPolicy method.

Fields
name

string

Required. The name of the Unified Access Policy to retrieve.

Format: * projects/{project_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * projects/{project_number}/locations/{location}/accessPolicies/{unified_access_policy_id} * folders/{folder_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * organizations/{organization_id}/locations/{location}/accessPolicies/{unified_access_policy_id}

GetPolicyBindingRequest

Request message for GetPolicyBinding method.

Fields
name

string

Required. The name of the policy binding to retrieve.

Format:

  • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
  • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
  • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
  • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}

GetPrincipalAccessBoundaryPolicyRequest

Request message for GetPrincipalAccessBoundaryPolicy method.

Fields
name

string

Required. The name of the principal access boundary policy to retrieve.

Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

ListAccessPoliciesRequest

Request message for ListAccessPolicies method.

Fields
parent

string

Required. The parent resource, which owns the collection of Unified Access Policy resources.

Format: * projects/{project_id}/locations/{location} * projects/{project_number}/locations/{location} * folders/{folder_id}/locations/{location} * organizations/{organization_id}/locations/{location}

page_size

int32

Optional. The maximum number of Unified Access Policies to return. The service might return a smaller number of bindings.

If unspecified, at most 50 Unified Access Policies are returned. Valid value ranges from 1 to 1000; values above 1000 are reduced to 1000.

page_token

string

Optional. A page token, received from a previous ListAccessPolicies call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccessPolicies must match the call that provided the page token.

filter

string

Optional. An expression for filtering the results of the request.

Example filter query: display_name:example* matches Unified Access Policies whose display name starts with "example".

ListAccessPoliciesResponse

Response message for ListAccessPolicies method.

Fields
access_policies[]

AccessPolicy

The Unified Access Policies from the specified parent.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListPolicyBindingsRequest

Request message for ListPolicyBindings method.

Fields
parent

string

Required. The parent resource, which owns the collection of policy bindings.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
page_size

int32

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

page_token

string

Optional. A page token, received from a previous ListPolicyBindings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPolicyBindings must match the call that provided the page token.

filter

string

Optional. An expression for filtering the results of the request. Filter rules are case insensitive. Some eligible fields for filtering are the following:

  • target
  • policy

Some examples of filter queries:

  • target:ex*: The binding target's name starts with "ex".
  • target:example: The binding target's name is example.
  • policy:example: The binding policy's name is example.

ListPolicyBindingsResponse

Response message for ListPolicyBindings method.

Fields
policy_bindings[]

PolicyBinding

The policy bindings from the specified parent.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListPrincipalAccessBoundaryPoliciesRequest

Request message for ListPrincipalAccessBoundaryPolicies method.

Fields
parent

string

Required. The parent resource, which owns the collection of principal access boundary policies.

Format: organizations/{organization_id}/locations/{location}

page_size

int32

Optional. The maximum number of principal access boundary policies to return. The service may return fewer than this value.

If unspecified, at most 50 principal access boundary policies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

Optional. A page token, received from a previous ListPrincipalAccessBoundaryPolicies call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPrincipalAccessBoundaryPolicies must match the call that provided the page token.

filter

string

Optional. An expression for filtering the results of the request.

Example filter query: display_name:example* matches principal access boundary policies whose display name starts with "example".

ListPrincipalAccessBoundaryPoliciesResponse

Response message for ListPrincipalAccessBoundaryPolicies method.

Fields
principal_access_boundary_policies[]

PrincipalAccessBoundaryPolicy

The principal access boundary policies from the specified parent.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.

end_time

Timestamp

Output only. The time the operation finished running.

target

string

Output only. Server-defined resource path for the target of the

verb

string

Output only. Name of the verb executed by the operation.

status_message

string

Output only. Human-readable status of the operation, if any.

requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

api_version

string

Output only. API version used to start the operation.

PolicyBinding

IAM policy binding resource.

Fields
name

string

Identifier. The name of the policy binding, in the format {binding_parent/locations/{location}/policyBindings/{policy_binding_id}. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target.

Format:

  • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
  • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
  • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
  • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
uid

string

Output only. The globally unique ID of the policy binding. Assigned when the policy binding is created.

etag

string

Optional. The etag for the policy binding. If this is provided on update, it must match the server's etag.

display_name

string

Optional. The description of the policy binding. Must be less than or equal to 63 characters.

annotations

map<string, string>

Optional. User-defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

target

Target

Required. Immutable. The full resource name of the resource to which the policy will be bound. Immutable once set.

policy_kind

PolicyKind

Immutable. The kind of the policy to attach in this binding. This field must be one of the following:

  • Left empty (will be automatically set to the policy kind)
  • The input policy kind
policy

string

Required. Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same organization.

policy_uid

string

Output only. The globally unique ID of the policy to be bound.

condition

Expr

Optional. The condition to apply to the policy binding. When set, the expression field in the Expr must include from 1 to 10 subexpressions, joined by the "||"(Logical OR), "&&"(Logical AND) or "!"(Logical NOT) operators and cannot contain more than 250 characters.

The condition is currently only supported when bound to policies of kind principal access boundary.

When the bound policy is a principal access boundary policy, the only supported attributes in any subexpression are principal.type and principal.subject. An example expression is: "principal.type == 'iam.googleapis.com/ServiceAccount'" or "principal.subject == 'bob@example.com'".

Allowed operations for principal.subject:

  • principal.subject == <principal subject string>
  • principal.subject != <principal subject string>
  • principal.subject in [<list of principal subjects>]
  • principal.subject.startsWith(<string>)
  • principal.subject.endsWith(<string>)

Allowed operations for principal.type:

  • principal.type == <principal type string>
  • principal.type != <principal type string>
  • principal.type in [<list of principal types>]

Supported principal types are workspace, workforce pool, workload pool, service account, and agent identity. Allowed string must be one of:

  • iam.googleapis.com/WorkspaceIdentity
  • iam.googleapis.com/WorkforcePoolIdentity
  • iam.googleapis.com/WorkloadPoolIdentity
  • iam.googleapis.com/ServiceAccount
  • iam.googleapis.com/AgentPoolIdentity
create_time

Timestamp

Output only. The time when the policy binding was created.

update_time

Timestamp

Output only. The time when the policy binding was most recently updated.

PolicyKind

The different policy kinds supported in this binding.

Enums
POLICY_KIND_UNSPECIFIED Unspecified policy kind; Not a valid state
PRINCIPAL_ACCESS_BOUNDARY Principal access boundary policy kind
ACCESS Unified Access Policy kind.

Target

The full resource name of the resource to which the policy will be bound. Immutable once set.

Fields
Union field target. The different types of targets that can be bound to a policy. target can be only one of the following:
principal_set

string

Immutable. The full resource name that's used for principal access boundary policy bindings. The principal set must be directly parented by the policy binding's parent or same as the parent if the target is a project, folder, or organization.

Examples:

  • For bindings parented by an organization:
    • Organization: //cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID
    • Workforce Identity: //iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID
    • Workspace Identity: //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • For bindings parented by a folder:
    • Folder: //cloudresourcemanager.googleapis.com/folders/FOLDER_ID
  • For bindings parented by a project:
    • Project:
      • //cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER
      • //cloudresourcemanager.googleapis.com/projects/PROJECT_ID
    • Workload Identity Pool: //iam.googleapis.com/projects/PROJECT_NUMBER/locations/LOCATION/workloadIdentityPools/WORKLOAD_POOL_ID
resource

string

Immutable. The full resource name that's used for Unified Access Policy bindings.

Examples:

  • Organization: //cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID
  • Folder: //cloudresourcemanager.googleapis.com/folders/FOLDER_ID
  • Project:
    • //cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER
    • //cloudresourcemanager.googleapis.com/projects/PROJECT_ID

PrincipalAccessBoundaryPolicy

An IAM principal access boundary policy resource.

Fields
name

string

Identifier. The resource name of the principal access boundary policy.

The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}

uid

string

Output only. The globally unique ID of the principal access boundary policy.

etag

string

Optional. The etag for the principal access boundary. If this is provided on update, it must match the server's etag.

display_name

string

Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.

annotations

map<string, string>

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

create_time

Timestamp

Output only. The time when the principal access boundary policy was created.

update_time

Timestamp

Output only. The time when the principal access boundary policy was most recently updated.

details

PrincipalAccessBoundaryPolicyDetails

Optional. The details for the principal access boundary policy.

PrincipalAccessBoundaryPolicyDetails

Principal access boundary policy details

Fields
rules[]

PrincipalAccessBoundaryPolicyRule

Required. A list of principal access boundary policy rules. The number of rules in a policy is limited to 500.

enforcement_version

string

Optional. The version number (for example, 1 or latest) that indicates which permissions are able to be blocked by the policy. If empty, the PAB policy version will be set to the most recent version number at the time of the policy's creation.

PrincipalAccessBoundaryPolicyRule

Principal access boundary policy rule that defines the resource boundary.

Fields
description

string

Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.

resources[]

string

Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy.

The following resource types are supported:

  • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
  • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
  • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
effect

Effect

Required. The access relationship of principals to the resources in this rule.

Effect

An effect to describe the access relationship.

Enums
EFFECT_UNSPECIFIED Effect unspecified.
ALLOW Allows access to the resources in this rule.

SearchAccessPolicyBindingsRequest

Request message for SearchAccessPolicyBindings rpc.

Fields
name

string

Required. The name of the Unified Access Policy.

Format: * organizations/{organization_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * folders/{folder_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * projects/{project_id}/locations/{location}/accessPolicies/{unified_access_policy_id} * projects/{project_number}/locations/{location}/accessPolicies/{unified_access_policy_id}

page_size

int32

Optional. The maximum number of Unified Access Policy bindings to return. The service might return a smaller number of bindings.

If unspecified, at most 50 bindings are returned. The maximum value is 1000; values above 1000 are reduced to 1000.

page_token

string

Optional. A page token, received from a previous SearchAccessPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchAccessPolicyBindingsRequest must match the call that provided the page token.

SearchAccessPolicyBindingsResponse

Response message for SearchAccessPolicyBindings rpc.

Fields
policy_bindings[]

PolicyBinding

The bindings that reference the specified Unified Access Policy.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

SearchPrincipalAccessBoundaryPolicyBindingsRequest

Request message for SearchPrincipalAccessBoundaryPolicyBindings rpc.

Fields
name

string

Required. The name of the principal access boundary policy. Format: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}

page_size

int32

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

If unspecified, at most 50 policy bindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

Optional. A page token, received from a previous SearchPrincipalAccessBoundaryPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchPrincipalAccessBoundaryPolicyBindingsRequest must match the call that provided the page token.

SearchPrincipalAccessBoundaryPolicyBindingsResponse

Response message for SearchPrincipalAccessBoundaryPolicyBindings rpc.

Fields
policy_bindings[]

PolicyBinding

The policy bindings that reference the specified policy.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

SearchTargetPolicyBindingsRequest

Request message for SearchTargetPolicyBindings method.

Fields
target

string

Required. The target resource, which is bound to the policy in the binding.

Format:

  • //iam.googleapis.com/locations/global/workforcePools/POOL_ID
  • //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID
  • //iam.googleapis.com/locations/global/workspace/WORKSPACE_ID
  • //cloudresourcemanager.googleapis.com/projects/{project_number}
  • //cloudresourcemanager.googleapis.com/folders/{folder_id}
  • //cloudresourcemanager.googleapis.com/organizations/{organization_id}
page_size

int32

Optional. The maximum number of policy bindings to return. The service may return fewer than this value.

The default value is 50. The maximum value is 1000.

page_token

string

Optional. A page token, received from a previous SearchTargetPolicyBindingsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchTargetPolicyBindingsRequest must match the call that provided the page token.

parent

string

Required. The parent resource where this search will be performed. This should be the nearest Resource Manager resource (project, folder, or organization) to the target.

Format:

  • projects/{project_id}/locations/{location}
  • projects/{project_number}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
filter

string

Optional. Filtering currently only supports the kind of policies to return, and must be in the format "policy_kind={policy_kind}".

If String is empty, bindings bound to all kinds of policies would be returned.

The only supported values are the following:

  • "policy_kind=PRINCIPAL_ACCESS_BOUNDARY",
  • "policy_kind=ACCESS"

SearchTargetPolicyBindingsResponse

Response message for SearchTargetPolicyBindings method.

Fields
policy_bindings[]

PolicyBinding

The policy bindings bound to the specified target.

next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

UpdateAccessPolicyRequest

Request message for UpdateAccessPolicy method.

Fields
access_policy

AccessPolicy

Required. The Unified Access Policy to update.

The Unified Access Policy's name field is used to identify the policy to update.

validate_only

bool

Optional. If set, validate the request and preview the update, but do not actually post it.

UpdatePolicyBindingRequest

Request message for UpdatePolicyBinding method.

Fields
policy_binding

PolicyBinding

Required. The policy binding to update.

The policy binding's name field is used to identify the policy binding to update.

validate_only

bool

Optional. If set, validate the request and preview the update, but do not actually post it.

update_mask

FieldMask

Optional. The list of fields to update

UpdatePrincipalAccessBoundaryPolicyRequest

Request message for UpdatePrincipalAccessBoundaryPolicy method.

Fields
principal_access_boundary_policy

PrincipalAccessBoundaryPolicy

Required. The principal access boundary policy to update.

The principal access boundary policy's name field is used to identify the policy to update.

validate_only

bool

Optional. If set, validate the request and preview the update, but do not actually post it.

update_mask

FieldMask

Optional. The list of fields to update