BeyondCorp API (beyondcorp:v1alpha)

2024-05-17

4 new methods

Additions

    Methods
  • beyondcorp.projects.locations.securityGateways.setIamPolicy

      Path : v1alpha/{+resource}:setIamPolicy

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setIamPolicy

      HTTP Method : POST

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

      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.

  • beyondcorp.projects.locations.securityGateways.getIamPolicy

      Path : v1alpha/{+resource}:getIamPolicy

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:getIamPolicy

      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.

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

          Location : path

          Required : Yes

          Type : string

        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

      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.securityGateways.testIamPermissions

      Path : v1alpha/{+resource}:testIamPermissions

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}: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.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

      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.organizations.locations.subscriptions.restart

      Path : v1alpha/{+name}:restart

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/subscriptions/{subscriptionsId}:restart

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Name of the resource.

          Pattern : ^organizations/[^/]+/locations/[^/]+/subscriptions/[^/]+$

          Location : path

          Required : Yes

          Type : string

        requestId

          Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      Parameter Order : name

      Description : Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective