2023-05-27
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.list
Parameters:
orderBy
Type: string
Description: Optional. Specifies the ordering of results. Currently, only ordering by the "name" and "create_time" fields are supported. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location: query
parent
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/locations/global$
Location: path
Description: Required. The parent organization to which the PartnerTenants belong. Format: `organizations/{organization_id}/locations/global`
filter
Type: string
Description: Optional. Filter partnerTenants to be returned. See [List Sub-Collections] (https://cloud.google.com/apis/design/design_patterns#list_sub-collections) for more details. All fields can be used in the filter. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed.
Location: query
pageToken
Type: string
Location: query
Description: Optional. A token identifying a page of results the server should return.
pageSize
Description: Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 are coerced to 1000. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Location: query
Type: integer
Parameter Order: parent
Description: Lists PartnerTenants in a given organization.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants
Path: v1alpha/{+parent}/partnerTenants
HTTP Method: GET
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.getIamPolicy
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
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.
Required: Yes
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
options.requestedPolicyVersion
Location: query
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).
Type: integer
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}: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.organizations.locations.global.partnerTenants.setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}: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.
Type: string
Location: path
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Required: Yes
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: v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.delete
Path: v1alpha/{+name}
Parameter Order: name
HTTP Method: DELETE
Parameters:
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).
Type: string
Location: query
name
Type: string
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Description: Required. Name of the resource.
Location: path
Required: Yes
Description: Deletes a single PartnerTenant.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.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: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Type: string
Required: Yes
Location: path
HTTP Method: POST
Parameter Order: resource
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: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:testIamPermissions
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.get
Parameters:
name
Location: path
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
Required: Yes
Description: Required. The resource name of the BrowserDlpRule using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}/browserDlpRules/{browser_dlp_rule_id}`
Type: string
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}
Path: v1alpha/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single BrowserDlpRule.
HTTP Method: GET
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.create
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules
Description: Creates a new BrowserDlpRule in a given organization and PartnerTenant.
HTTP Method: POST
Parameters:
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).
Location: query
Type: string
parent
Type: string
Description: Required. The resource name of the BrowserDlpRule parent using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/browserDlpRules
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: GET
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
Parameters:
resource
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
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.
Type: string
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
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.organizations.locations.global.partnerTenants.browserDlpRules.testIamPermissions
Parameter Order: resource
Path: v1alpha/{+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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions
Parameters:
resource
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
Type: string
Required: Yes
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.
HTTP Method: POST
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:setIamPolicy
Parameters:
resource
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+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
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/proxyConfigs
HTTP Method: POST
Parameters:
requestId
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).
Location: query
parent
Description: Required. The resource name of the Tenant using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}`
Type: string
Location: path
Required: Yes
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs
Description: Creates a new BeyondCorp Enterprise ProxyConfig in a given organization and PartnerTenant. Can only be called by on onboarded Beyondcorp Enterprise partner.
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+resource}: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.
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:getIamPolicy
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: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Location: path
Type: string
Required: Yes
options.requestedPolicyVersion
Location: query
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).
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Location: path
Description: Required. The resource name of the ProxyConfig using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}/proxyConfigs/{proxy_config_id}`
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Required: Yes
Type: string
Parameter Order: name
Path: v1alpha/{+name}
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}
Description: Gets details of a single ProxyConfig.
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.setIamPolicy
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:setIamPolicy
Parameters:
resource
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
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
Location: path
Type: string
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: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:setIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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
Pattern: ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Required: Yes
Location: path
Type: string
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.
Parameter Order: resource
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
▼ ▲ beyondcorp.organizations.locations.global.tenants.proxyConfigs.delete
Description: Deletes a single ProxyConfig.
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}/proxyConfigs/{proxyConfigsId}
HTTP Method: DELETE
Parameters:
requestId
Type: string
Location: query
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).
name
Location: path
Type: string
Description: Required. Name of the resource.
Pattern: ^organizations/[^/]+/locations/global/tenants/[^/]+/proxyConfigs/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}
▼ ▲ beyondcorp.organizations.locations.global.tenants.delete
Path: v1alpha/{+name}
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
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
name
Required: Yes
Location: path
Type: string
Description: Required. Name of the resource.
Pattern: ^organizations/[^/]+/locations/global/tenants/[^/]+$
Flat Path: v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}
Description: Deletes a single Tenant.