BeyondCorp API (beyondcorp:v1)

2022-06-26

21 new methods | New API

Additions

    Methods
  • beyondcorp.projects.locations.clientConnectorServices.getIamPolicy

      HTTP Method : GET

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

      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.

      Parameters :

        options.requestedPolicyVersion

          Type : integer

          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

        resource

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

          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.

          Required : Yes

          Location : path

      Path : v1/{+resource}:getIamPolicy

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

  • beyondcorp.projects.locations.clientConnectorServices.setIamPolicy

      Parameter Order : resource

      Path : v1/{+resource}:setIamPolicy

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

      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

          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

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

          Location : path

          Type : string

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

      HTTP Method : POST

  • beyondcorp.projects.locations.clientConnectorServices.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.

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

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

      Path : v1/{+resource}:testIamPermissions

      Parameters :

        resource

          Type : string

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

          Location : path

          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.

          Required : Yes

      HTTP Method : POST

      Parameter Order : resource

  • beyondcorp.projects.locations.appConnectors.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.

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

      Path : v1/{+resource}:setIamPolicy

      HTTP Method : POST

      Parameter Order : resource

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

      Parameters :

        resource

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

          Type : string

          Required : Yes

          Location : path

          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.appConnectors.getIamPolicy

      HTTP Method : GET

      Parameters :

        options.requestedPolicyVersion

          Format : int32

          Type : integer

          Location : query

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

        resource

          Location : path

          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/[^/]+/appConnectors/[^/]+$

          Type : string

          Required : Yes

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

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

      Parameter Order : resource

      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.

  • beyondcorp.projects.locations.appConnectors.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

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

      Path : v1/{+resource}:testIamPermissions

      HTTP Method : POST

      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

          Type : string

          Required : Yes

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

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

  • beyondcorp.projects.locations.operations.delete

      HTTP Method : DELETE

      Parameters :

        name

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

          Type : string

          Location : path

          Required : Yes

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

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

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

      Path : v1/{+name}

      Parameter Order : name

  • beyondcorp.projects.locations.operations.list

      Path : v1/{+name}/operations

      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.

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

      Parameters :

        name

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

          Type : string

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

          Location : path

          Required : Yes

        pageSize

          Format : int32

          Location : query

          Type : integer

          Description : The standard list page size.

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

      Parameter Order : name

      HTTP Method : GET

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

  • beyondcorp.projects.locations.operations.get

      Parameters :

        name

          Description : The name of the operation resource.

          Required : Yes

          Location : path

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

          Type : string

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

      Parameter Order : name

      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.

      HTTP Method : GET

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

      Path : v1/{+name}

  • beyondcorp.projects.locations.operations.cancel

      Parameters :

        name

          Type : string

          Required : Yes

          Location : path

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

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

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

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

      HTTP Method : POST

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

      Parameter Order : name

      Path : v1/{+name}:cancel

  • beyondcorp.projects.locations.clientGateways.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

      Parameter Order : resource

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

      Parameters :

        options.requestedPolicyVersion

          Type : integer

          Location : query

          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

        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.

          Required : Yes

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

          Location : path

      Path : v1/{+resource}:getIamPolicy

  • beyondcorp.projects.locations.clientGateways.setIamPolicy

      Parameters :

        resource

          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.

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

          Location : path

          Type : string

          Required : Yes

      Parameter Order : resource

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

      Path : v1/{+resource}: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.

      HTTP Method : POST

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

  • beyondcorp.projects.locations.clientGateways.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

          Type : string

          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.

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

          Location : path

      HTTP Method : POST

      Path : v1/{+resource}:testIamPermissions

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

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

  • beyondcorp.projects.locations.appGateways.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.

      HTTP Method : POST

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

      Path : v1/{+resource}:setIamPolicy

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

      Parameter Order : resource

      Parameters :

        resource

          Location : path

          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

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

          Required : Yes

  • beyondcorp.projects.locations.appGateways.testIamPermissions

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

      Path : v1/{+resource}:testIamPermissions

      HTTP Method : POST

      Parameters :

        resource

          Location : path

          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

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

          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.

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

      Parameter Order : resource

  • beyondcorp.projects.locations.appGateways.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

      HTTP Method : GET

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

      Parameters :

        options.requestedPolicyVersion

          Type : integer

          Location : query

          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

        resource

          Required : Yes

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

          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

          Type : string

      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

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

  • beyondcorp.projects.locations.appConnections.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.

      HTTP Method : POST

      Parameters :

        resource

          Type : string

          Location : path

          Required : Yes

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

          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.

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

      Path : v1/{+resource}:setIamPolicy

  • beyondcorp.projects.locations.appConnections.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

      Parameter Order : resource

      HTTP Method : POST

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

      Parameters :

        resource

          Type : string

          Location : path

          Required : Yes

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

          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.

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

      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.appConnections.getIamPolicy

      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

          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

          Location : path

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

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

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

      Parameter Order : resource

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

      HTTP Method : GET

      Path : v1/{+resource}:getIamPolicy

  • beyondcorp.projects.locations.list

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

      Path : v1/{+name}/locations

      Parameters :

        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

          Type : integer

          Format : int32

          Location : query

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

        name

          Required : Yes

          Pattern : ^projects/[^/]+$

          Type : string

          Location : path

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

        pageToken

          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

          Type : string

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

      Parameter Order : name

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

      HTTP Method : GET

  • beyondcorp.projects.locations.get

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

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

      Parameter Order : name

      Description : Gets information about a location.

      Path : v1/{+name}

      Parameters :

        name

          Required : Yes

          Type : string

          Description : Resource name for the location.

          Location : path

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

      HTTP Method : GET