BeyondCorp API (beyondcorp:v1alpha)

2023-05-06

4 new methods

Additions

    Methods
  • beyondcorp.organizations.locations.global.tenants.get

      Flat Path: v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}

      Description: Gets details of a single Tenant.

      Path: v1alpha/{+name}

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

      Parameters:

        name

          Required: Yes

          Location: path

          Pattern: ^organizations/[^/]+/locations/global/tenants/[^/]+$

          Description: Required. The resource name of the Tenant using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}`

          Type: string

      Parameter Order: name

      HTTP Method: GET

  • beyondcorp.organizations.locations.global.tenants.create

      Description: Creates a new BeyondCorp Enterprise tenant in a given organization and can only be called by onboarded BeyondCorp Enterprise partner.

      Path: v1alpha/{+parent}/tenants

      Parameters:

        parent

          Description: Required. The resource name of the Tenant using the form: `organizations/{organization_id}/locations/global`

          Type: string

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

          Required: Yes

          Location: path

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

          Type: string

          Location: query

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

      Parameter Order: parent

      HTTP Method: POST

      Flat Path: v1alpha/organizations/{organizationsId}/locations/global/tenants

  • beyondcorp.organizations.locations.global.tenants.proxyConfigs.get

      Path: v1alpha/{+name}

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

      Parameters:

        name

          Required: Yes

          Location: path

          Description: Required. The resource name of the Tenant using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}/proxyConfigs/{proxy_config_id}`

          Type: string

          Pattern: ^organizations/[^/]+/locations/global/tenants/[^/]+/proxyConfigs/[^/]+$

      Description: Gets details of a single Tenant.

      Parameter Order: name

      HTTP Method: GET

      Flat Path: v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}/proxyConfigs/{proxyConfigsId}

  • beyondcorp.organizations.locations.global.tenants.proxyConfigs.create

      Flat Path: v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}/proxyConfigs

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

      HTTP Method: POST

      Parameter Order: parent

      Path: v1alpha/{+parent}/proxyConfigs

      Description: Creates a new BeyondCorp Enterprise ProxyConfiguration in a given organization and tenant. Can only be called by on onboarded Beyondcorp Enterprise partner.

      Parameters:

        requestId

          Location: query

          Type: string

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

        parent

          Pattern: ^organizations/[^/]+/locations/global/tenants/[^/]+$

          Description: Required. The resource name of the ProxyConfig using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}`

          Location: path

          Required: Yes

          Type: string