BeyondCorp API (beyondcorp:v1)

2022-06-22

21 new methods | New API

Additions

    Methods
  • beyondcorp.projects.locations.operations.cancel

      Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

      Parameters:

        name

          Description: The name of the operation resource to be cancelled.

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required: Yes

          Location: path

          Type: string

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      Path: v1/{+name}:cancel

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

  • beyondcorp.projects.locations.operations.list

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

      Path: v1/{+name}/operations

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: The standard list page token.

        name

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Required: Yes

          Location: path

          Description: The name of the operation's parent resource.

        pageSize

          Location: query

          Format: int32

          Type: integer

          Description: The standard list page size.

        filter

          Description: The standard list filter.

          Type: string

          Location: query

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

  • beyondcorp.projects.locations.operations.delete

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Parameters:

        name

          Required: Yes

          Type: string

          Description: The name of the operation resource to be deleted.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

      Path: v1/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: DELETE

      Parameter Order: name

  • beyondcorp.projects.locations.operations.get

      Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Path: v1/{+name}

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Parameters:

        name

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Required: Yes

          Type: string

          Description: The name of the operation resource.

  • beyondcorp.projects.locations.appConnectors.testIamPermissions

      Parameter Order: resource

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+resource}:testIamPermissions

      HTTP Method: POST

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Parameters:

        resource

          Required: Yes

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:testIamPermissions

  • beyondcorp.projects.locations.appConnectors.setIamPolicy

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location: path

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:setIamPolicy

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Parameter Order: resource

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+resource}:setIamPolicy

  • beyondcorp.projects.locations.appConnectors.getIamPolicy

      Parameters:

        resource

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

          Location: path

        options.requestedPolicyVersion

          Type: integer

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Format: int32

          Location: query

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+resource}:getIamPolicy

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Parameter Order: resource

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:getIamPolicy

  • beyondcorp.projects.locations.appConnections.testIamPermissions

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$

          Type: string

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Path: v1/{+resource}:testIamPermissions

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Parameter Order: resource

  • beyondcorp.projects.locations.appConnections.getIamPolicy

      Parameter Order: resource

      Parameters:

        options.requestedPolicyVersion

          Format: int32

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Type: integer

        resource

          Type: string

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:getIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      HTTP Method: GET

  • beyondcorp.projects.locations.appConnections.setIamPolicy

      Parameter Order: resource

      Path: v1/{+resource}:setIamPolicy

      HTTP Method: POST

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

          Location: path

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy

  • beyondcorp.projects.locations.clientConnectorServices.testIamPermissions

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$

          Required: Yes

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Parameter Order: resource

      Path: v1/{+resource}:testIamPermissions

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • beyondcorp.projects.locations.clientConnectorServices.getIamPolicy

      Parameter Order: resource

      Path: v1/{+resource}:getIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Parameters:

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Type: integer

          Format: int32

          Location: query

        resource

          Location: path

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$

          Type: string

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy

  • beyondcorp.projects.locations.clientConnectorServices.setIamPolicy

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Path: v1/{+resource}:setIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        resource

          Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$

          Location: path

          Required: Yes

          Type: string

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

      HTTP Method: POST

      Parameter Order: resource

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy

  • beyondcorp.projects.locations.clientGateways.testIamPermissions

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Parameter Order: resource

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$

          Type: string

          Location: path

          Required: Yes

      Path: v1/{+resource}:testIamPermissions

      HTTP Method: POST

  • beyondcorp.projects.locations.clientGateways.setIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:setIamPolicy

      HTTP Method: POST

      Path: v1/{+resource}:setIamPolicy

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: resource

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Parameters:

        resource

          Location: path

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

  • beyondcorp.projects.locations.clientGateways.getIamPolicy

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy

      Parameters:

        resource

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

          Required: Yes

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Format: int32

          Type: integer

      Parameter Order: resource

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Path: v1/{+resource}:getIamPolicy

  • beyondcorp.projects.locations.appGateways.testIamPermissions

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$

          Location: path

          Type: string

          Required: Yes

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Path: v1/{+resource}:testIamPermissions

      Parameter Order: resource

  • beyondcorp.projects.locations.appGateways.setIamPolicy

      Path: v1/{+resource}:setIamPolicy

      Parameters:

        resource

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required: Yes

      HTTP Method: POST

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: resource

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:setIamPolicy

  • beyondcorp.projects.locations.appGateways.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      HTTP Method: GET

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$

          Required: Yes

          Location: path

        options.requestedPolicyVersion

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Location: query

          Type: integer

          Format: int32

      Parameter Order: resource

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • beyondcorp.projects.locations.list

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Type: string

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Description: The resource that owns the locations collection, if applicable.

        filter

          Type: string

          Location: query

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

        pageSize

          Description: The maximum number of results to return. If not set, the service selects a default.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Type: string

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location: query

      Path: v1/{+name}/locations

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations

      Description: Lists information about the supported locations for this service.

  • beyondcorp.projects.locations.get

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+name}

      Parameters:

        name

          Required: Yes

          Description: Resource name for the location.

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

      HTTP Method: GET

      Parameter Order: name

      Description: Gets information about a location.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}