REST Resource: accessPolicies.servicePerimeters

• Resource: ServicePerimeter
  • JSON representation
• PerimeterType
• ServicePerimeterConfig
  • JSON representation
• Methods

Resource: ServicePerimeter

ServicePerimeter describes a set of GCP 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 GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges.

JSON representation
{ "name": string, "title": string, "description": string, "createTime": string, "updateTime": string, "perimeterType": enum (PerimeterType), "status": { object (ServicePerimeterConfig) } }

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.
createTime	string (Timestamp format) Output only. Time the ServicePerimeter was created in UTC. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
updateTime	string (Timestamp format) Output only. Time the ServicePerimeter was updated in UTC. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
perimeterType	enum (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	object (ServicePerimeterConfig) Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

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 GCP resources that describe specific Service Perimeter configuration.

JSON representation
{ "resources": [ string ], "accessLevels": [ string ], "restrictedServices": [ string ] }

Fields
resources[]	string A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
accessLevels[]	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 GCP calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.
restrictedServices[]	string GCP 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.

Methods
create	Create an Service Perimeter.
delete	Delete an Service Perimeter by resource name.
get	Get an Service Perimeter by resource name.
list	List all Service Perimeters for an access policy.
patch	Update an Service Perimeter.