Package google.identity.accesscontextmanager.v1alpha

Index

AccessContextManager

API for setting Access Levels and Service Perimeters for Google Cloud Projects. Each organization has one AccessPolicy containing the Access Levels and Service Perimeters. This AccessPolicy is applicable to all resources in the organization. AccessPolicies

CommitServicePerimeters

rpc CommitServicePerimeters(CommitServicePerimetersRequest) returns (Operation)

Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its spec field to that Service Perimeter's status field. Only Service Perimeters with use_explicit_dry_run_spec field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The dry_run and the spec fields will be cleared after a successful commit operation.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateAccessLevel

rpc CreateAccessLevel(CreateAccessLevelRequest) returns (Operation)

Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateAccessPolicy

rpc CreateAccessPolicy(AccessPolicy) returns (Operation)

Create an AccessPolicy. Fails if this organization already has a AccessPolicy. The longrunning Operation will have a successful status once the AccessPolicy has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in metadata as a BadRequest proto.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateGcpUserAccessBinding

rpc CreateGcpUserAccessBinding(CreateGcpUserAccessBindingRequest) returns (Operation)

Creates a GcpUserAccessBinding. If the client specifies a name, the server will ignore it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CreateServicePerimeter

rpc CreateServicePerimeter(CreateServicePerimeterRequest) returns (Operation)

Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteAccessLevel

rpc DeleteAccessLevel(DeleteAccessLevelRequest) returns (Operation)

Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteAccessPolicy

rpc DeleteAccessPolicy(DeleteAccessPolicyRequest) returns (Operation)

Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteGcpUserAccessBinding

rpc DeleteGcpUserAccessBinding(DeleteGcpUserAccessBindingRequest) returns (Operation)

Deletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

DeleteServicePerimeter

rpc DeleteServicePerimeter(DeleteServicePerimeterRequest) returns (Operation)

Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetAccessLevel

rpc GetAccessLevel(GetAccessLevelRequest) returns (AccessLevel)

Get an Access Level by resource name.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetAccessPolicy

rpc GetAccessPolicy(GetAccessPolicyRequest) returns (AccessPolicy)

Get an AccessPolicy by name.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetGcpUserAccessBinding

rpc GetGcpUserAccessBinding(GetGcpUserAccessBindingRequest) returns (GcpUserAccessBinding)

Gets the GcpUserAccessBinding with the given name.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

GetServicePerimeter

rpc GetServicePerimeter(GetServicePerimeterRequest) returns (ServicePerimeter)

Get a Service Perimeter by resource name.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListAccessLevels

rpc ListAccessLevels(ListAccessLevelsRequest) returns (ListAccessLevelsResponse)

List all Access Levels for an access policy.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListAccessPolicies

rpc ListAccessPolicies(ListAccessPoliciesRequest) returns (ListAccessPoliciesResponse)

List all AccessPolicies under a container.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListGcpUserAccessBindings

rpc ListGcpUserAccessBindings(ListGcpUserAccessBindingsRequest) returns (ListGcpUserAccessBindingsResponse)

Lists all GcpUserAccessBindings for a Google Cloud organization.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ListServicePerimeters

rpc ListServicePerimeters(ListServicePerimetersRequest) returns (ListServicePerimetersResponse)

List all Service Perimeters for an access policy.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ReplaceAccessLevels

rpc ReplaceAccessLevels(ReplaceAccessLevelsRequest) returns (Operation)

Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error existing Access Levels will not affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ReplaceServicePerimeters

rpc ReplaceServicePerimeters(ReplaceServicePerimetersRequest) returns (Operation)

Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateAccessLevel

rpc UpdateAccessLevel(UpdateAccessLevelRequest) returns (Operation)

Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateAccessPolicy

rpc UpdateAccessPolicy(UpdateAccessPolicyRequest) returns (Operation)

Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in metadata as a BadRequest proto.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateGcpUserAccessBinding

rpc UpdateGcpUserAccessBinding(UpdateGcpUserAccessBindingRequest) returns (Operation)

Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

UpdateServicePerimeter

rpc UpdateServicePerimeter(UpdateServicePerimeterRequest) returns (Operation)

Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

AccessLevel

An AccessLevel is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.

Fields
name

string

Required. Resource name for the Access Level. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/accessLevels/{short_name}. The maximum length // of the short_name component is 50 characters.

title

string

Human readable title. Must be unique within the Policy.

description

string

Description of the AccessLevel and its use. Does not affect behavior.

Union field level. Required. Describes the necessary conditions for the level to apply. level can be only one of the following:
basic

BasicLevel

A BasicLevel composed of Conditions.

custom

CustomLevel

A CustomLevel written in the Common Expression Language.

AccessPolicy

AccessPolicy is a container for AccessLevels (which define the necessary attributes to use Google Cloud services) and ServicePerimeters (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.

Fields
name

string

Output only. Resource name of the AccessPolicy. Format: accessPolicies/{policy_id}

parent

string

Required. The parent of this AccessPolicy in the Cloud Resource Hierarchy. Currently immutable once created. Format: organizations/{organization_id}

title

string

Required. Human readable title. Does not affect behavior.

etag

string

Output only. An opaque identifier for the current version of the AccessPolicy. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.

AllowedIdentity

Specifies the types of identities that are allowed access in either IngressFrom or EgressFrom rules.

Enums
ALLOWED_IDENTITY_UNSPECIFIED No blanket identity group specified.
ANY_IDENTITY Authorize access from all identities outside the perimeter.
ANY_USER Authorize access from all human users outside the perimeter.
ANY_SERVICE_ACCOUNT Authorize access from all service accounts outside the perimeter.

ApiActionType

The type of ApiAction specified for a service specified in ApiOperation.

Enums
ACTION_TYPE_UNSPECIFIED No type for the action is specified.
METHOD Action is a method.
PERMISSION Action is an IAM Permission.

BasicLevel

BasicLevel is an AccessLevel using a set of recommended features.

Fields
conditions[]

Condition

Required. A list of requirements for the AccessLevel to be granted.

combining_function

ConditionCombiningFunction

How the conditions list should be combined to determine if a request is granted this AccessLevel. If AND is used, each Condition in conditions must be satisfied for the AccessLevel to be applied. If OR is used, at least one Condition in conditions must be satisfied for the AccessLevel to be applied. Default behavior is AND.

ConditionCombiningFunction

Options for how the conditions list should be combined to determine if this AccessLevel is applied. Default is AND.

Enums
AND All Conditions must be true for the BasicLevel to be true.
OR If at least one Condition is true, then the BasicLevel is true.

CommitServicePerimetersRequest

A request to commit dry-run specs in all Service Perimeters belonging to an Access Policy.

Fields
parent

string

Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation.

Format: accessPolicies/{policy_id}

etag

string

Optional. The etag for the version of the Access Policy that this commit operation is to be performed on. If, at the time of commit, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the commit operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided.

CommitServicePerimetersResponse

A response to CommitServicePerimetersRequest. This will be put inside of Operation.response field.

Fields
service_perimeters[]

ServicePerimeter

List of all the Service Perimeter instances in the Access Policy.

Condition

A condition necessary for an AccessLevel to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.

Fields
ip_subnetworks[]

string

CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

device_policy

DevicePolicy

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.

required_access_levels[]

string

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: "accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"

negate

bool

Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

members[]

string

The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: user:{emailid} serviceAccount:{emailid} If not specified, a request may come from any user.

regions[]

string

The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

CreateAccessLevelRequest

A request to create an AccessLevel.

Fields
parent

string

Required. Resource name for the access policy which owns this Access Level.

Format: accessPolicies/{policy_id}

access_level

AccessLevel

Required. The Access Level to create. Syntactic correctness of the Access Level is a precondition for creation.

CreateGcpUserAccessBindingRequest

Request of CreateGcpUserAccessBinding.

Fields
parent

string

Required. Example: "organizations/256"

gcp_user_access_binding

GcpUserAccessBinding

Required. GcpUserAccessBinding

CreateServicePerimeterRequest

A request to create a ServicePerimeter.

Fields
parent

string

Required. Resource name for the access policy which owns this Service Perimeter.

Format: accessPolicies/{policy_id}

service_perimeter

ServicePerimeter

Required. The Service Perimeter to create. Syntactic correctness of the Service Perimeter is a precondition for creation.

CustomLevel

CustomLevel is an AccessLevel using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec

Fields
expr

Expr

Required. A Cloud CEL expression evaluating to a boolean.

DeleteAccessLevelRequest

A request to delete an AccessLevel.

Fields
name

string

Required. Resource name for the Access Level.

Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

DeleteAccessPolicyRequest

A request to delete an AccessPolicy.

Fields
name

string

Required. Resource name for the access policy to delete.

Format accessPolicies/{policy_id}

DeleteGcpUserAccessBindingRequest

Request of DeleteGcpUserAccessBinding.

Fields
name

string

Required. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"

DeleteServicePerimeterRequest

A request to delete a ServicePerimeter.

Fields
name

string

Required. Resource name for the Service Perimeter.

Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}

DevicePolicy

DevicePolicy specifies device specific restrictions necessary to acquire a given access level. A DevicePolicy specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. DevicePolicy acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops.

Fields
require_screenlock

bool

Whether or not screenlock is required for the DevicePolicy to be true. Defaults to false.

allowed_encryption_statuses[]

DeviceEncryptionStatus

Allowed encryptions statuses, an empty list allows all statuses.

os_constraints[]

OsConstraint

Allowed OS versions, an empty list allows all types and all versions.

allowed_device_management_levels[]

DeviceManagementLevel

Allowed device management levels, an empty list allows all management levels.

require_admin_approval

bool

Whether the device needs to be approved by the customer admin.

require_corp_owned

bool

Whether the device needs to be corp owned.

GcpUserAccessBinding

Restricts access to Cloud Console and Google Cloud APIs for a set of users using Context-Aware Access.

Fields
name

string

Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by RFC 3986 Section 2.3). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"

group_key

string

Required. Immutable. Google Group id whose members are subject to this binding's restrictions. See "id" in the G Suite Directory API's Groups resource. If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht"

access_levels[]

string

Required. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted"

GetAccessLevelRequest

A request to get a particular AccessLevel.

Fields
name

string

Required. Resource name for the Access Level.

Format: accessPolicies/{policy_id}/accessLevels/{access_level_id}

access_level_format

LevelFormat

Whether to return BasicLevels in the Cloud Common Expression Language rather than as BasicLevels. Defaults to AS_DEFINED, where Access Levels are returned as BasicLevels or CustomLevels based on how they were created. If set to CEL, all Access Levels are returned as CustomLevels. In the CEL case, BasicLevels are translated to equivalent CustomLevels.

GetAccessPolicyRequest

A request to get a particular AccessPolicy.

Fields
name

string

Required. Resource name for the access policy to get.

Format accessPolicies/{policy_id}

GetGcpUserAccessBindingRequest

Request of GetGcpUserAccessBinding.

Fields
name

string

Required. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"

GetServicePerimeterRequest

A request to get a particular ServicePerimeter.

Fields
name

string

Required. Resource name for the Service Perimeter.

Format: accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}

LevelFormat

The format used in an AccessLevel.

Enums
LEVEL_FORMAT_UNSPECIFIED The format was not specified.
AS_DEFINED Uses the format the resource was defined in. BasicLevels are returned as BasicLevels, CustomLevels are returned as CustomLevels.
CEL Use Cloud Common Expression Language when returning the resource. Both BasicLevels and CustomLevels are returned as CustomLevels.

ListAccessLevelsRequest

A request to list all AccessLevels in an AccessPolicy.

Fields
parent

string

Required. Resource name for the access policy to list Access Levels from.

Format: accessPolicies/{policy_id}

page_size

int32

Number of Access Levels to include in the list. Default 100.

page_token

string

Next page token for the next batch of Access Level instances. Defaults to the first page of results.

access_level_format

LevelFormat

Whether to return BasicLevels in the Cloud Common Expression language, as CustomLevels, rather than as BasicLevels. Defaults to returning AccessLevels in the format they were defined.

ListAccessLevelsResponse

A response to ListAccessLevelsRequest.

Fields
access_levels[]

AccessLevel

List of the Access Level instances.

next_page_token

string

The pagination token to retrieve the next page of results. If the value is empty, no further results remain.

ListAccessPoliciesRequest

A request to list all AccessPolicies for a container.

Fields
parent

string

Required. Resource name for the container to list AccessPolicy instances from.

Format: organizations/{org_id}

page_size

int32

Number of AccessPolicy instances to include in the list. Default 100.

page_token

string

Next page token for the next batch of AccessPolicy instances. Defaults to the first page of results.

ListAccessPoliciesResponse

A response to ListAccessPoliciesRequest.

Fields
access_policies[]

AccessPolicy

List of the AccessPolicy instances.

next_page_token

string

The pagination token to retrieve the next page of results. If the value is empty, no further results remain.

ListGcpUserAccessBindingsRequest

Request of ListGcpUserAccessBindings.

Fields
parent

string

Required. Example: "organizations/256"

page_size

int32

Optional. Maximum number of items to return. The server may return fewer items. If left blank, the server may return any number of items.

page_token

string

Optional. If left blank, returns the first page. To enumerate all items, use the next_page_token from your previous list operation.

ListGcpUserAccessBindingsResponse

Response of ListGcpUserAccessBindings.

Fields
gcp_user_access_bindings[]

GcpUserAccessBinding

GcpUserAccessBinding

next_page_token

string

Token to get the next page of items. If blank, there are no more items.

ListServicePerimetersRequest

A request to list all ServicePerimeters in an AccessPolicy.

Fields
parent

string

Required. Resource name for the access policy to list Service Perimeters from.

Format: accessPolicies/{policy_id}

page_size

int32

Number of Service Perimeters to include in the list. Default 100.

page_token

string

Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results.

ListServicePerimetersResponse

A response to ListServicePerimetersRequest.

Fields
service_perimeters[]

ServicePerimeter

List of the Service Perimeter instances.

next_page_token

string

The pagination token to retrieve the next page of results. If the value is empty, no further results remain.

OsConstraint

A restriction on the OS type and version of devices making requests.

Fields
os_type

OsType

Required. The allowed OS type.

minimum_version

string

The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: "major.minor.patch". Examples: "10.5.301", "9.2.1".

require_verified_chrome_os

bool

Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request.

ReplaceAccessLevelsRequest

A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically.

Fields
parent

string

Required. Resource name for the access policy which owns these Access Levels.

Format: accessPolicies/{policy_id}

access_levels[]

AccessLevel

Required. The desired Access Levels that should replace all existing Access Levels in the Access Policy.

etag

string

Optional. The etag for the version of the Access Policy that this replace operation is to be performed on. If, at the time of replace, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the replace operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided.

ReplaceAccessLevelsResponse

A response to ReplaceAccessLevelsRequest. This will be put inside of Operation.response field.

Fields
access_levels[]

AccessLevel

List of the Access Level instances.

ReplaceServicePerimetersRequest

A request to replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically.

Fields
parent

string

Required. Resource name for the access policy which owns these Service Perimeters.

Format: accessPolicies/{policy_id}

service_perimeters[]

ServicePerimeter

Required. The desired Service Perimeters that should replace all existing Service Perimeters in the Access Policy.

etag

string

Optional. The etag for the version of the Access Policy that this replace operation is to be performed on. If, at the time of replace, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the replace operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided.

ReplaceServicePerimetersResponse

A response to ReplaceServicePerimetersRequest. This will be put inside of Operation.response field.

Fields
service_perimeters[]

ServicePerimeter

List of the Service Perimeter instances.

ServicePerimeter

ServicePerimeter describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the ServicePerimeter. If a request with a source within this ServicePerimeter has a target outside of the ServicePerimeter, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.

Fields
name

string

Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/servicePerimeters/{short_name}

title

string

Human readable title. Must be unique within the Policy.

description

string

Description of the ServicePerimeter and its use. Does not affect behavior.

perimeter_type

PerimeterType

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

status

ServicePerimeterConfig

Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

spec

ServicePerimeterConfig

Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set.

use_explicit_dry_run_spec

bool

Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values.

PerimeterType

Specifies the type of the Perimeter. There are two types: regular and bridge. Regular Service Perimeter contains resources, access levels, and restricted services. Every resource can be in at most ONE regular Service Perimeter.

In addition to being in a regular service perimeter, a resource can also be in zero or more perimeter bridges. A perimeter bridge only contains resources. Cross project operations are permitted if all effected resources share some perimeter (whether bridge or regular). Perimeter Bridge does not contain access levels or services: those are governed entirely by the regular perimeter that resource is in.

Perimeter Bridges are typically useful when building more complex toplogies with many independent perimeters that need to share some data with a common perimeter, but should not be able to share data among themselves.

Enums
PERIMETER_TYPE_REGULAR Regular Perimeter.
PERIMETER_TYPE_BRIDGE Perimeter Bridge.

ServicePerimeterConfig

ServicePerimeterConfig specifies a set of Google Cloud resources that describe specific Service Perimeter configuration.

Fields
resources[]

string

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

access_levels[]

string

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

restricted_services[]

string

Google Cloud services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

vpc_accessible_services

VpcAccessibleServices

Configuration for APIs allowed within Perimeter.

ingress_policies[]

IngressPolicy

List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge.

egress_policies[]

EgressPolicy

List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge.

ApiAction

An allowed action of a service specified in ApiOperation.

Fields
action_type

ApiActionType

The type of the action to allow for an API service. It can be one of METHOD (method of a service), PERMISSION (Cloud IAM Permission), or ACTION_TYPE_UNSPECIFIED. If action_type is not set or set to ACTION_TYPE_UNSPECIFIED, and action is *, then ALL actions are allowed.

action

string

The API method name or Cloud IAM permission name to allow. If METHOD is chosen for action_type, then a valid method name for the corresponding service_name in ApiOperation must be provided (e.g. method name TableDataService.List for the service bigquery.googelapis.com). If PERMISSION is chosen for action_type, then a valid Cloud IAM permission for the corresponding service_name in ApiOperation must be provided (e.g. bigquery.jobs.update for the service bigquery.googleapis.com). If action_type is not set or set to ACTION_TYPE_UNSPECIFIED, and action is *, then ALL actions are allowed.

ApiOperation

Identification for an API Operation.

Fields
service_name

string

The API service that this ApiOperation relates to. An empty list of services is not allowed. Set this field to * to authorize access to all services. The actions field will be ignored if this field is set to *.

actions[]

ApiAction

API actions to allow for the service specified by service_name field. A single ApiAction entry with wildcard * for ApiAction.action field will allow all actions for service specified in service_name.

EgressFrom

Defines the conditions under which this EgressPolicy matches a request, based on information about the source of the request. Currently, only ANY_IDENTITY is supported. This means that the Egress rule allows all identities to perform the ApiOperations on the resources specified in EgressTo. Note that in order for the ApiOperations to succeed, the Service Perimeter protecting the specified resources in EgressTo must have an IngressPolicy which allows such ApiOperations from such sources.

Fields
allowed_identity

AllowedIdentity

Specifies the identities that are allowed through the EgressPolicy. Currently, only ANY_IDENTITY (everything is allowed) is supported.

EgressPolicy

Policy for egress from perimeter.

EgressPolicies match requests based on egress_from and egress_to stanzas. For an EgressPolicy to match, both egress_from and egress_to stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset).

EgressPolicies are concerned with the resources that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo.

Fields
egress_from

EgressFrom

Defines conditions on the source of a request causing this EgressPolicy to apply.

egress_to

EgressTo

Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply.

EgressTo

Defines the conditions under which this EgressPolicy matches a request, based on information about the API and resources that the request affects. To match a egress_to stanza, the request must match BOTH resources and operations. This specifies the ApiOperations the sources in EgressFrom are able to perform on the resources specified. Note that in order for the ApiOperations to succeed, the Service Perimeter protecting the specified resources must have an IngressPolicy which allows such ApiOperations from such sources.

Fields
resources[]

string

A list of resources, currently only projects in the form projects/<projectnumber>, that match this to stanza. A request matches if it contains a resource in this list. If * is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.

operations[]

ApiOperation

A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.

IngressFrom

Rule specifying information about the source of a request in an IngressPolicy.

Fields
allowed_identity

AllowedIdentity

Specifies the identities that are allowed access from outside the perimeter. Can be one of ANY_IDENTITY (everything is allowed), ANY_USER (all human users), ANY_SERVICE_ACCOUNT (all service accounts), or ALLOWED_IDENTITY_UNSPECIFIED (only the specified emails in the identities field are able to access).

sources[]

IngressSource

Sources that this ingress policy authorizes access from.

identities[]

string

A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only.

IngressPolicy

Policy for ingress into ServicePerimeter.

IngressPolicies match requests based on ingress_from and ingress_to stanzas. For an ingress policy to match, both the ingress_from and ingress_to stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter.

For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required.

Individual ingress policies can be limited by restricting which services and/or actions they match using the ingress_to field.

Fields
ingress_from

IngressFrom

Defines the conditions on the source of a request causing this IngressPolicy to apply.

ingress_to

IngressTo

Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply.

IngressSource

The source that IngressPolicy authorizes access from.

Fields
Union field source. Allowed ingress source. It can be one of AccessLevel or Google Cloud resource. source can be only one of the following:
access_level

string

An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: accessPolicies/MY_POLICY/accessLevels/MY_LEVEL. If * is specified, then all IngressSources will be allowed. This is due to an AccessLevel can be made permissive enough to allow Google Cloud resources as well.

resource

string

A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: projects/{project_number} The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. * is not allowed, the case of allowing all Google Cloud resources only is not supported.

IngressTo

Rule specifying information about the destination of a request in an IngressPolicy.

Fields
operations[]

ApiOperation

A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.

VpcAccessibleServices

Specifies how APIs are allowed to communicate within the Service Perimeter.

Fields
enable_restriction

bool

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.

allowed_services[]

string

The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.

UpdateAccessLevelRequest

A request to update an AccessLevel.

Fields
access_level

AccessLevel

Required. The updated Access Level. Syntactic correctness of the Access Level is a precondition for creation.

update_mask

FieldMask

Required. Mask to control which fields get updated. Must be non-empty.

UpdateAccessPolicyRequest

A request to update an AccessPolicy.

Fields
policy

AccessPolicy

Required. The updated AccessPolicy.

update_mask

FieldMask

Required. Mask to control which fields get updated. Must be non-empty.

UpdateGcpUserAccessBindingRequest

Request of UpdateGcpUserAccessBinding.

Fields
gcp_user_access_binding

GcpUserAccessBinding

Required. GcpUserAccessBinding

update_mask

FieldMask

Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and must always be:

update_mask { paths: "access_levels" }

UpdateServicePerimeterRequest

A request to update a ServicePerimeter.

Fields
service_perimeter

ServicePerimeter

Required. The updated ServicePerimeter. Syntactic correctness of the ServicePerimeter is a precondition for creation.

update_mask

FieldMask

Required. Mask to control which fields get updated. Must be non-empty.