Cloud Controls Partner API (cloudcontrolspartner:v1)

2024-03-28

10 new methods | New API

Additions

    Methods
  • cloudcontrolspartner.organizations.locations.getPartner

      Path: v1/{+name}

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/partner

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Format: `organizations/{organization}/locations/{location}/partner`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Get details of a Partner.

  • cloudcontrolspartner.organizations.locations.customers.get

      Path: v1/{+name}

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets details of a single customer

  • cloudcontrolspartner.organizations.locations.customers.list

      Path: v1/{+parent}/customers

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Parent resource Format: `organizations/{organization}/locations/{location}`

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token, received from a previous `ListCustomers` call. Provide this to retrieve the subsequent page.

          Location: query

          Type: string

        filter

          Description: Optional. Filtering results

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists customers of a partner identified by its Google Cloud organization ID

  • cloudcontrolspartner.organizations.locations.customers.workloads.get

      Path: v1/{+name}

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`

          Pattern: ^organizations/[^/]+/locations/[^/]+/customers/[^/]+/workloads/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets details of a single workload

  • cloudcontrolspartner.organizations.locations.customers.workloads.list

      Path: v1/{+parent}/workloads

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}`

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token, received from a previous `ListWorkloads` call. Provide this to retrieve the subsequent page.

          Location: query

          Type: string

        filter

          Description: Optional. Filtering results.

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists customer workloads for a given customer org id

  • cloudcontrolspartner.organizations.locations.customers.workloads.getEkmConnections

      Path: v1/{+name}

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/ekmConnections

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections`

          Pattern: ^organizations/[^/]+/locations/[^/]+/customers/[^/]+/workloads/[^/]+/ekmConnections$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets the EKM connections associated with a workload

  • cloudcontrolspartner.organizations.locations.customers.workloads.getPartnerPermissions

      Path: v1/{+name}

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/partnerPermissions

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Name of the resource to get in the format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions`

          Pattern: ^organizations/[^/]+/locations/[^/]+/customers/[^/]+/workloads/[^/]+/partnerPermissions$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets the partner permissions granted for a workload

  • cloudcontrolspartner.organizations.locations.customers.workloads.accessApprovalRequests.list

      Path: v1/{+parent}/accessApprovalRequests

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/accessApprovalRequests

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`

          Pattern: ^organizations/[^/]+/locations/[^/]+/customers/[^/]+/workloads/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of access requests to return. The service may return fewer than this value. If unspecified, at most 500 access requests will be returned.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. A page token, received from a previous `ListAccessApprovalRequests` call. Provide this to retrieve the subsequent page.

          Location: query

          Type: string

        filter

          Description: Optional. Filtering results.

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists access requests associated with a workload

  • cloudcontrolspartner.organizations.locations.customers.workloads.violations.list

      Path: v1/{+parent}/violations

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/violations

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Parent resource Format `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`

          Pattern: ^organizations/[^/]+/locations/[^/]+/customers/[^/]+/workloads/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of customers row to return. The service may return fewer than this value. If unspecified, at most 10 customers will be returned.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. A page token, received from a previous `ListViolations` call. Provide this to retrieve the subsequent page.

          Location: query

          Type: string

        filter

          Description: Optional. Filtering results

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results

          Location: query

          Type: string

        interval.startTime

          Description: Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

          Location: query

          Type: string

          Format: google-datetime

        interval.endTime

          Description: Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

          Location: query

          Type: string

          Format: google-datetime

      Parameter Order: parent

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

      Description: Lists Violations for a workload Callers may also choose to read across multiple Customers or for a single customer as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of {customer} & {workload}. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`

  • cloudcontrolspartner.organizations.locations.customers.workloads.violations.get

      Path: v1/{+name}

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/customers/{customersId}/workloads/{workloadsId}/violations/{violationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/violations/{violation}`

          Pattern: ^organizations/[^/]+/locations/[^/]+/customers/[^/]+/workloads/[^/]+/violations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets details of a single Violation.