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

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.

CreateServicePerimeter

rpc CreateServicePerimeter(CreateServicePerimeterRequest) returns (Operation)

Create an 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.

DeleteServicePerimeter

rpc DeleteServicePerimeter(DeleteServicePerimeterRequest) returns (Operation)

Delete an 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.

GetServicePerimeter

rpc GetServicePerimeter(GetServicePerimeterRequest) returns (ServicePerimeter)

Get an 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.

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.

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.

UpdateServicePerimeter

rpc UpdateServicePerimeter(UpdateServicePerimeterRequest) returns (Operation)

Update an 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 GCP 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}

title

string

Human readable title. Must be unique within the Policy.

description

string

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

create_time

Timestamp

Output only. Time the AccessLevel was created in UTC.

update_time

Timestamp

Output only. Time the AccessLevel was updated in UTC.

basic

BasicLevel

A BasicLevel composed of Conditions.

AccessPolicy

AccessPolicy is a container for AccessLevels (which define the necessary attributes to use GCP 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.

create_time

Timestamp

Output only. Time the AccessPolicy was created in UTC.

update_time

Timestamp

Output only. Time the AccessPolicy was updated in UTC.

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.

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.

CreateServicePerimeterRequest

A request to create an 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.

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}

DeleteServicePerimeterRequest

A request to delete an 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.

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}

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.

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.

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.

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.

create_time

Timestamp

Output only. Time the ServicePerimeter was created in UTC.

update_time

Timestamp

Output only. Time the ServicePerimeter was updated in UTC.

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.

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.

Fields
resources[]

string

A list of GCP 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 GCP calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

restricted_services[]

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.

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.

UpdateServicePerimeterRequest

A request to update an 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.

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Access Context Manager