Package google.identity.accesscontextmanager.v1

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. Any non-empty field criteria evaluating to false will result in the Condition 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.
`vpc_network_sources[]`	`VpcNetworkSource` The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.

CreateAccessLevelRequest

A request to create an AccessLevel.

Fields

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.

parent

string

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

Format: accessPolicies/{policy_id}

access_level

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

CreateAuthorizedOrgsDescRequest

A request to create a AuthorizedOrgsDesc.

Fields

Fields
`parent`	`string` Required. Resource name for the access policy which owns this `Authorized Orgs Desc`. Format: `accessPolicies/{policy_id}`
`authorized_orgs_desc`	`AuthorizedOrgsDesc` Required. The `Authorized Orgs Desc` to create. Syntactic correctness of the `Authorized Orgs Desc` is a precondition for creation.

parent

string

Required. Resource name for the access policy which owns this Authorized Orgs Desc.

Format: accessPolicies/{policy_id}

authorized_orgs_desc

AuthorizedOrgsDesc

Required. The Authorized Orgs Desc to create. Syntactic correctness of the Authorized Orgs Desc is a precondition for creation.

CreateGcpUserAccessBindingRequest

Request of CreateGcpUserAccessBinding.

Fields

Fields
`parent`	`string` Required. Example: "organizations/256"
`gcp_user_access_binding`	`GcpUserAccessBinding` Required. `GcpUserAccessBinding`

parent

string

Required. Example: "organizations/256"

gcp_user_access_binding

GcpUserAccessBinding

Required. GcpUserAccessBinding

CreateServicePerimeterRequest

A request to create a ServicePerimeter.

Fields

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.

parent

string

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

Format: accessPolicies/{policy_id}

service_perimeter

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

Fields
`expr`	`Expr` Required. A Cloud CEL expression evaluating to a boolean.

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}

DeleteAuthorizedOrgsDescRequest

A request to delete a AuthorizedOrgsDesc.

Fields

name

string

Required. Resource name for the Authorized Orgs Desc.

Format: accessPolicies/{policy_id}/authorizedOrgsDesc/{authorized_orgs_desc_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` Optional. 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"
`dry_run_access_levels[]`	`string` Optional. Dry run access level that will be evaluated but will not be enforced. The access denial based on dry run policy will be logged. Only one access level is supported, not multiple. This list must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted"
`session_settings`	`SessionSettings` Optional. GCSL policy for the group key.
`restricted_client_applications[]`	`Application` Optional. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications.
`scoped_access_settings[]`	`ScopedAccessSettings` Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set.

GcpUserAccessBindingOperationMetadata

This type has no fields.

Metadata of GCP Access Binding Long Running Operations.

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}

GetAuthorizedOrgsDescRequest

A request to get a particular AuthorizedOrgsDesc.

Fields

name

string

Required. Resource name for the Authorized Orgs Desc.

Format: accessPolicies/{policy_id}/authorizedOrgsDescs/{authorized_orgs_descs_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}

GetSupportedServiceRequest

Determines whether the service is supported by VPC Service Controls. The SupportStatus field of the returned response indicates whether the service is fully supported by VPC Service Controls.

Fields

name

string

The name of the service to get information about. The names must be in the same format as used in defining a service perimeter, for example, storage.googleapis.com.

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[]

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.

ListAuthorizedOrgsDescsRequest

A request to list of all of the AuthorizedOrgsDesc in an AccessPolicy.

Fields

parent

string

Required. Resource name for the access policy to list Authorized Orgs Desc from.

Format: accessPolicies/{policy_id}

page_size

int32

Number of Authorized Orgs Descs to include in the list. Default 100.

page_token

string

Next page token for the next batch of Authorized Orgs Desc instances. Defaults to the first page of results.

ListAuthorizedOrgsDescsResponse

A response to ListAuthorizedOrgsDescsRequest.

Fields

authorized_orgs_descs[]

AuthorizedOrgsDesc

List of all the Authorized Orgs Desc 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

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[]

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.

ListSupportedServicesRequest

Lists the services that VPC Service Controls supports. The services that are in this list either fully support VPC Service Controls or the integration of this service with VPC Service Controls is in Preview stage. Services that aren't in this list don't support VPC Service Controls and aren't guaranteed to function properly in a VPC Service Controls environment.

Fields

page_size

int32

This flag specifies the maximum number of services to return per page. Default is 100.

page_token

string

Token to start on a later page. Default is the first page.

ListSupportedServicesResponse

A response to ListSupportedServicesRequest.

Fields

supported_services[]

SupportedService

List of services supported by VPC Service Controls 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[]

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[]

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[]

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

etag

string

ReplaceServicePerimetersResponse

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

Fields

service_perimeters[]

List of the Service Perimeter instances.

ScopedAccessSettings

A relationship between access settings and its scope.

Fields

scope

AccessScope

Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty.

active_settings

AccessSettings

Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set.

dry_run_settings

AccessSettings

Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set.

AccessScope

Access scope represents the client scope, etc. to which the settings will be applied to.

Fields

client_scope

ClientScope

Optional. Client scope for this access scope.

AccessSettings

Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set.

Fields

access_levels[]

string

Optional. 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"

session_settings

SessionSettings

Optional. Session settings applied to user access on a given AccessScope.

ClientScope

Client scope represents the application, etc. subject to this binding's restrictions.

Fields

Union field scope. Client Scope Identifier scope can be only one of the following:

restricted_client_application

Application

Optional. The application that is subject to this binding's scope.

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 or VPC network 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` Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `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 or VPC network 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.
`etag`	`string` Optional. An opaque identifier for the current version of the `ServicePerimeter`. This identifier does not follow any specific format. If an etag is not provided, the operation will be performed as if a valid etag is provided.

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. When no value is specified, the perimeter uses this type.
`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 and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`.
`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.

ApiOperation

Identification for an API Operation.

Fields

service_name

string

The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with service_name field set to * will allow all methods AND permissions for all services.

method_selectors[]

MethodSelector

API methods or permissions to allow. Method or permission must belong to the service specified by service_name field. A single MethodSelector entry with * specified for the method field will allow all methods AND permissions for the service specified in service_name.

EgressFrom

Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.

Fields
`identities[]`	`string` A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.
`identity_type`	`IdentityType` Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
`sources[]`	`EgressSource` Sources that this `EgressPolicy` authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
`source_restriction`	`SourceRestriction` Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.

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.

EgressSource

The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.

Fields

Union field source. Allowed egress source. source can be only one of the following:

access_level

string

An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: accessPolicies/MY_POLICY/accessLevels/MY_LEVEL. If a single * is specified for access_level, then all EgressSources will be allowed.

EgressTo

Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the resources specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match operations AND resources fields in order to be allowed egress out of the perimeter.

Fields

resources[]

string

A list of resources, currently only projects in the form projects/<projectnumber>, that are allowed to be accessed by sources defined in the corresponding EgressFrom. 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 allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.

external_resources[]

string

A list of external resources that are allowed to be accessed. Only AWS and Azure resources are supported. For Amazon S3, the supported formats are s3://BUCKET_NAME, s3a://BUCKET_NAME, and s3n://BUCKET_NAME. For Azure Storage, the supported format is azure://myaccount.blob.core.windows.net/CONTAINER_NAME. A request matches if it contains an external resource in this list (Example: s3://bucket/path). Currently '*' is not allowed.

IdentityType

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

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

IngressFrom

Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in sources AND identity related fields in order to match.

Fields

sources[]

IngressSource

Sources that this IngressPolicy authorizes access from.

identities[]

string

A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The v1 identities that have the prefix user, group, serviceAccount, and principal in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.

identity_type

IdentityType

Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of identities field will be allowed access.

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 will cause an 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 a single * is specified for access_level, then all IngressSources will be allowed.

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 and VPCs are allowed. Project format: projects/{project_number} VPC network format: //compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}. 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

Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in operations AND resources in order to match.

Fields

operations[]

ApiOperation

A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.

resources[]

string

A list of resources, currently only projects in the form projects/<projectnumber>, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single * is specified, then access to all resources inside the perimeter are allowed.

MethodSelector

An allowed method or permission of a service specified in ApiOperation.

Fields

Union field kind. The API method name or Cloud IAM permission name to allow. kind can be only one of the following:

method

string

A valid method name for the corresponding service_name in ApiOperation. If * is used as the value for the method, then ALL methods and permissions are allowed.

permission

string

A valid Cloud IAM permission for the corresponding service_name in ApiOperation.

SourceRestriction

Whether to enable the enforcement of traffic based on on the sources field. Only applies to EgressFrom.

Enums
`SOURCE_RESTRICTION_UNSPECIFIED`	Enforcement preference unspecified, will not enforce traffic restrictions based on `sources` in `EgressFrom`.
`SOURCE_RESTRICTION_ENABLED`	Enforcement preference enabled, traffic restrictions will be enforced based on `sources` in `EgressFrom`.
`SOURCE_RESTRICTION_DISABLED`	Enforcement preference disabled, will not enforce traffic restrictions based on `sources` in `EgressFrom`.

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.

ServiceSupportStage

The support stage of the service.

Enums
`SERVICE_SUPPORT_STAGE_UNSPECIFIED`	Do not use this default value.
`GA`	GA features are open to all developers and are considered stable and fully qualified for production use.
`PREVIEW`	PREVIEW indicates a pre-release stage where the product is functionally complete but undergoing real-world testing.
`DEPRECATED`	Deprecated features are scheduled to be shut down and removed.

SessionSettings

Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings.

Fields
`session_reauth_method`	`SessionReauthMethod` Optional. Session method when users GCP session is up.
`session_length`	`Duration` Optional. The session length. Setting this field to zero is equal to disabling. Session. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param.
`max_inactivity`	`Duration` Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps.
`use_oidc_max_age`	`bool` Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param.
`session_length_enabled`	`bool` Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite.

SessionReauthMethod

The session challenges proposed to users when the GCP session length is up.

Enums
`SESSION_REAUTH_METHOD_UNSPECIFIED`	If method undefined in API, we will use LOGIN by default.
`LOGIN`	The user will prompted to perform regular login. Users who are enrolled for two-step verification and haven't chosen to "Remember this computer" will be prompted for their second factor.
`SECURITY_KEY`	The user will be prompted to autheticate using their security key. If no security key has been configured, then we will fallback to LOGIN.
`PASSWORD`	The user will be prompted for their password.

SupportedService

SupportedService specifies the VPC Service Controls and its properties.

Fields
`name`	`string` The service name or address of the supported service, such as `service.googleapis.com`.
`support_stage`	`LaunchStage` The support stage of the service.
`available_on_restricted_vip`	`bool` True if the service is available on the restricted VIP. Services on the restricted VIP typically either support VPC Service Controls or are core infrastructure services required for the functioning of Google Cloud.
`title`	`string` The name of the supported product, such as 'Cloud Product API'.
`supported_methods[]`	`MethodSelector` The list of the supported methods. This field exists only in response to `GetSupportedService`
`known_limitations`	`bool` True if the service is supported with some limitations. Check documentation for details.
`service_support_stage`	`ServiceSupportStage` The support stage of the service.

UpdateAccessLevelRequest

A request to update an AccessLevel.

Fields

access_level

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

update_mask

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

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

UpdateAuthorizedOrgsDescRequest

A request to update a AuthorizedOrgsDesc.

Fields

authorized_orgs_desc

AuthorizedOrgsDesc

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

update_mask

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

Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: access_levels, dry_run_access_levels, reauth_settings session_settings, scoped_access_settings.

update_mask { paths: "access_levels" }

append

bool

Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite.

So far, only scoped_access_settings with reauth_settings supports appending. Global access_levels, access_levels in scoped_access_settings, dry_run_access_levels, reauth_settings, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when "scoped_access_settings" is not set in the update_mask.

UpdateServicePerimeterRequest

A request to update a ServicePerimeter.

Fields

service_perimeter

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

update_mask