2023-05-24
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.list
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists PartnerTenants in a given organization.
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants
Path : v1alpha/{+parent}/partnerTenants
Parameters :
pageToken
Description : Optional. A token identifying a page of results the server should return.
Type : string
Location : query
pageSize
Format : int32
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.
Type : integer
Location : query
orderBy
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.
Type : string
Location : query
parent
Required : Yes
Location : path
Type : string
Description : Required. The parent organization to which the PartnerTenants belong. Format: `organizations/{organization_id}/locations/global`
Pattern : ^organizations/[^/]+/locations/global$
filter
Location : query
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.
Type : string
HTTP Method : GET
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.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.
Parameters :
resource
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.
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Type : string
Location : path
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:setIamPolicy
HTTP Method : POST
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.testIamPermissions
HTTP Method : POST
Path : v1alpha/{+resource}:testIamPermissions
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.
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.
Type : string
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Location : path
Required : Yes
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:testIamPermissions
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.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.
Type : string
Required : Yes
Location : path
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
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
Parameter Order : resource
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}:getIamPolicy
HTTP Method : GET
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+resource}:getIamPolicy
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.delete
Description : Deletes a single PartnerTenant.
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}
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 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
Required : Yes
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Location : path
Type : string
Description : Required. Name of the resource.
Path : v1alpha/{+name}
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.create
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs
Path : v1alpha/{+parent}/proxyConfigs
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 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
Description : Required. The resource name of the Tenant using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}`
Required : Yes
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
Type : string
Location : path
HTTP Method : POST
Description : Creates a new BeyondCorp Enterprise ProxyConfig in a given organization and PartnerTenant. Can only be called by on onboarded Beyondcorp Enterprise partner.
Parameter Order : parent
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.testIamPermissions
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.
HTTP Method : POST
Path : v1alpha/{+resource}:testIamPermissions
Parameter Order : resource
Parameters :
resource
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.
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Location : path
Required : Yes
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:testIamPermissions
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
options.requestedPolicyVersion
Format : int32
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).
Location : query
resource
Location : path
Type : string
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 : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Parameter Order : resource
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:getIamPolicy
Path : v1alpha/{+resource}:getIamPolicy
HTTP Method : GET
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.proxyConfigs.get
Parameters :
name
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Location : path
Type : string
Description : Required. The resource name of the ProxyConfig using the form: `organizations/{organization_id}/locations/global/tenants/{tenant_id}/proxyConfigs/{proxy_config_id}`
Required : Yes
Parameter Order : name
Path : v1alpha/{+name}
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}
Description : Gets details of a single ProxyConfig.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.proxyConfigs.setIamPolicy
Parameter Order : resource
HTTP Method : POST
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.
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/proxyConfigs/[^/]+$
Required : Yes
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+resource}:setIamPolicy
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/proxyConfigs/{proxyConfigsId}:setIamPolicy
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.getIamPolicy
HTTP Method : GET
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.
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:getIamPolicy
Parameters :
resource
Required : Yes
Location : path
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.
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
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).
Parameter Order : resource
Path : v1alpha/{+resource}:getIamPolicy
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.get
Parameter Order : name
HTTP Method : GET
Parameters :
name
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}`
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}
Description : Gets details of a single BrowserDlpRule.
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.testIamPermissions
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.
HTTP Method : POST
Parameter Order : resource
Path : v1alpha/{+resource}:testIamPermissions
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:testIamPermissions
Parameters :
resource
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
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.
Required : Yes
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules/{browserDlpRulesId}:setIamPolicy
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.
Parameters :
resource
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.
Required : Yes
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+/browserDlpRules/[^/]+$
Location : path
HTTP Method : POST
▼ ▲ beyondcorp.organizations.locations.global.partnerTenants.browserDlpRules.create
Path : v1alpha/{+parent}/browserDlpRules
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Type : string
Description : Required. The resource name of the BrowserDlpRule parent using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`
Pattern : ^organizations/[^/]+/locations/global/partnerTenants/[^/]+$
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
Description : Creates a new BrowserDlpRule in a given organization and PartnerTenant.
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}/browserDlpRules
▼ ▲ beyondcorp.organizations.locations.global.tenants.delete
Parameter Order : name
Description : Deletes a single Tenant.
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 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
Required : Yes
Type : string
Pattern : ^organizations/[^/]+/locations/global/tenants/[^/]+$
Description : Required. Name of the resource.
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}
Path : v1alpha/{+name}
▼ ▲ beyondcorp.organizations.locations.global.tenants.proxyConfigs.delete
Path : v1alpha/{+name}
Flat Path : v1alpha/organizations/{organizationsId}/locations/global/tenants/{tenantsId}/proxyConfigs/{proxyConfigsId}
Description : Deletes a single ProxyConfig.
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 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
name
Description : Required. Name of the resource.
Pattern : ^organizations/[^/]+/locations/global/tenants/[^/]+/proxyConfigs/[^/]+$
Type : string
Required : Yes
Location : path
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name