Method: providers.entitlements.list

List Entitlements for which the provider has read access.

HTTP request

GET https://cloudcommerceprocurement.googleapis.com/v1/{parent=providers/*}/entitlements

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent resource name.

Authorization requires the following Google IAM permission on the specified resource parent:

  • commerceprocurement.providerEntitlements.list

Query parameters

Parameters
filter

string

The filter that can be used to limit the list request.

The filter is a query string that can match a selected set of attributes with string values. For example account=E-1234-5678-ABCD-EFGH, state=pending_cancellation, and product!=foo-product. Supported query attributes are

  • account
  • product
  • plan
  • newPendingPlan or newPendingPlan
  • state

Note that the state name match is case-insensitive and query can omit the prefix "ENTITLEMENT_". For example, state=active is equivalent to state=ENTITLEMENT_ACTIVE.

If the query contains some special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, product="providerId:productId", where the product name needs to be quoted because it contains special character colon.

Queries can be combined with AND, OR, and NOT to form more complex queries. They can also be grouped to force a desired evaluation order. For example, state=active AND (account=E-1234 OR account=5678) AND NOT (product=foo-product). Connective AND can be omitted between two predicates. For example account=E-1234 state=active is equivalent to account=E-1234 AND state=active.

pageSize

number

The maximum number of entries that are requested.

pageToken

string

The token for fetching the next page.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for PartnerProcurementService.ListEntitlements.

JSON representation
{
  "entitlements": [
    {
      object (Entitlement)
    }
  ],
  "nextPageToken": string
}
Fields
entitlements[]

object (Entitlement)

The list of entitlements in this response.

nextPageToken

string

The token for fetching the next page.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Оцените, насколько информация на этой странице была вам полезна:

Оставить отзыв о...

Текущей странице
GCP Marketplace