Console
    Contact Us Start free

    Package google.iam.v3beta

    Index

    AccessPolicies

    Manages Identity and Access Management (IAM) access policies.

    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. Once the binding is created, the policy is applied to the target.

    Authorization scopes

    Requires the following OAuth scope:

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

    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. Once the binding is deleted, the policy no longer applies to the target.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the Authentication Overview .

    GetPolicyBinding

    rpc GetPolicyBinding( GetPolicyBindingRequest ) returns ( PolicyBinding )

    Gets a policy binding.

    Authorization scopes

    Requires the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 the following OAuth scope:

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

    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 .

    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.

    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.

    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}

    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.

    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 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:

    • 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.

    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 and Service Account. Allowed string must be one of:

    • iam.googleapis.com/WorkspaceIdentity
    • iam.googleapis.com/WorkforcePoolIdentity
    • iam.googleapis.com/WorkloadPoolIdentity
    • iam.googleapis.com/ServiceAccount
    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

    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

    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.

    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.

    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 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}

    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.

    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
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: