BeyondCorp API

Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.

Service: beyondcorp.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://beyondcorp.googleapis.com

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.appConnections

Methods
create POST /v1/{parent=projects/*/locations/*}/appConnections
Creates a new AppConnection in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/appConnections/*}
Deletes a single AppConnection.
get GET /v1/{name=projects/*/locations/*/appConnections/*}
Gets details of a single AppConnection.
getIamPolicy GET /v1/{resource=projects/*/locations/*/appConnections/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/appConnections
Lists AppConnections in a given project and location.
patch PATCH /v1/{appConnection.name=projects/*/locations/*/appConnections/*}
Updates the parameters of a single AppConnection.
resolve GET /v1/{parent=projects/*/locations/*}/appConnections:resolve
Resolves AppConnections details for a given AppConnector.
setIamPolicy POST /v1/{resource=projects/*/locations/*/appConnections/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/appConnections/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.appConnectors

Methods
create POST /v1/{parent=projects/*/locations/*}/appConnectors
Creates a new AppConnector in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/appConnectors/*}
Deletes a single AppConnector.
get GET /v1/{name=projects/*/locations/*/appConnectors/*}
Gets details of a single AppConnector.
getIamPolicy GET /v1/{resource=projects/*/locations/*/appConnectors/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/appConnectors
Lists AppConnectors in a given project and location.
patch PATCH /v1/{appConnector.name=projects/*/locations/*/appConnectors/*}
Updates the parameters of a single AppConnector.
reportStatus POST /v1/{appConnector=projects/*/locations/*/appConnectors/*}:reportStatus
Report status for a given connector.
resolveInstanceConfig GET /v1/{appConnector=projects/*/locations/*/appConnectors/*}:resolveInstanceConfig
Get instance config for a given AppConnector.
setIamPolicy POST /v1/{resource=projects/*/locations/*/appConnectors/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/appConnectors/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.appGateways

Methods
create POST /v1/{parent=projects/*/locations/*}/appGateways
Creates a new AppGateway in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/appGateways/*}
Deletes a single AppGateway.
get GET /v1/{name=projects/*/locations/*/appGateways/*}
Gets details of a single AppGateway.
getIamPolicy GET /v1/{resource=projects/*/locations/*/appGateways/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/appGateways
Lists AppGateways in a given project and location.
setIamPolicy POST /v1/{resource=projects/*/locations/*/appGateways/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/appGateways/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.clientConnectorServices

Methods
create POST /v1/{parent=projects/*/locations/*}/clientConnectorServices
Creates a new ClientConnectorService in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/clientConnectorServices/*}
Deletes a single ClientConnectorService.
get GET /v1/{name=projects/*/locations/*/clientConnectorServices/*}
Gets details of a single ClientConnectorService.
getIamPolicy GET /v1/{resource=projects/*/locations/*/clientConnectorServices/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/clientConnectorServices
Lists ClientConnectorServices in a given project and location.
patch PATCH /v1/{clientConnectorService.name=projects/*/locations/*/clientConnectorServices/*}
Updates the parameters of a single ClientConnectorService.
setIamPolicy POST /v1/{resource=projects/*/locations/*/clientConnectorServices/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/clientConnectorServices/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.clientGateways

Methods
create POST /v1/{parent=projects/*/locations/*}/clientGateways
Creates a new ClientGateway in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/clientGateways/*}
Deletes a single ClientGateway.
get GET /v1/{name=projects/*/locations/*/clientGateways/*}
Gets details of a single ClientGateway.
getIamPolicy GET /v1/{resource=projects/*/locations/*/clientGateways/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/clientGateways
Lists ClientGateways in a given project and location.
setIamPolicy POST /v1/{resource=projects/*/locations/*/clientGateways/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/clientGateways/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.