REST Resource: accessPolicies.servicePerimeters

Resource: 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 is blocked. Otherwise the request is allowed. There are two types of service perimeter: regular and bridge. Regular perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular perimeter. Perimeter bridges can contain only Google Cloud projects as members, a single Google Cloud project might belong to multiple Service perimeter bridges.

JSON representation 
{
  "name": string,
  "title": string,
  "description": string,
  "perimeterType": enum (PerimeterType),
  "status": {
    object (ServicePerimeterConfig)
  },
  "spec": {
    object (ServicePerimeterConfig)
  },
  "useExplicitDryRunSpec": boolean,
  "etag": string
}
Fields
name

string

Identifier. Resource name for the ServicePerimeter. Format: accessPolicies/{access_policy}/servicePerimeters/{servicePerimeter}.

The servicePerimeter 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.
perimeterType

enum (PerimeterType)

Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but a project can be in 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.
spec

object (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 "useExplicitDryRunSpec" flag is set.
useExplicitDryRunSpec

boolean

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

JSON representation 
{
  "resources": [
    string
  ],
  "accessLevels": [
    string
  ],
  "restrictedServices": [
    string
  ],
  "vpcAccessibleServices": {
    object (VpcAccessibleServices)
  },
  "ingressPolicies": [
    {
      object (IngressPolicy)
    }
  ],
  "egressPolicies": [
    {
      object (EgressPolicy)
    }
  ]
}
Fields
resources[]

string

A list Google Cloud resources that are inside of the service perimeter. Only projects, VPCs are allowed. Project format: projects/{projectNumber}. VPC network format: //compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}.
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 through Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.
restrictedServices[]

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

object (VpcAccessibleServices)

Configuration for APIs allowed within Perimeter.
ingressPolicies[]

object (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.
egressPolicies[]

object (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.

VpcAccessibleServices

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

JSON representation 
{
  "enableRestriction": boolean,
  "allowedServices": [
    string
  ],
  "allowedServicePatterns": [
    {
      object (ServicePattern)
    }
  ],
  "servicePatternsEnforcementScopes": [
    enum (ServicePatternsEnforcementScope)
  ]
}
Fields
enableRestriction

boolean

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

string

The list of APIs usable within the Service Perimeter. Must be empty unless 'enableRestriction' 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.
allowedServicePatterns[]

object (ServicePattern)

Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter.
servicePatternsEnforcementScopes[]

enum (ServicePatternsEnforcementScope)

Defines the enforcement scopes of service patterns.

ServicePattern

Service patterns used to allow access.

JSON representation 
{
  "modifiers": [
    {
      object (Modifier)
    }
  ],

  // Union field kind can be only one of the following:
  "service": string,
  "pattern": string
  // End of list of possible types for union field kind.
}
Fields
modifiers[]

object (Modifier)

Modifiers to apply to the requests that match the URL pattern.
Union field kind. The service or pattern to allow. kind can be only one of the following:
service

string

Supported service to allow.
pattern

string

URL pattern to allow.

Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be an alphanumeric name.

Modifier

Modifier to apply to the API requests.

JSON representation 
{

  // Union field kind can be only one of the following:
  "addRequestHeader": {
    object (AddRequestHeader)
  }
  // End of list of possible types for union field kind.
}
Fields
Union field kind. Modifier to apply to the API requests. kind can be only one of the following:
addRequestHeader

object (AddRequestHeader)

Adds an additional HTTP request header.

AddRequestHeader

Adds a request header to the API.

JSON representation