Method: providers.entitlements.approve

Approves an entitlement that is in the EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED state.

This method is invoked by the provider to approve the creation of the entitlement resource.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the entitlement, with the format providers/{providerId}/entitlements/{entitlementId}.

Authorization requires the following IAM permission on the specified resource name:

  • commerceprocurement.providerEntitlements.approve

Request body

The request body contains data with the following structure:

JSON representation
  "properties": {
    string: string,
  "entitlementMigrated": string

map (key: string, value: string)

Set of properties that should be associated with the entitlement. Optional.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.



Optional. The resource name of the entitlement that was migrated, with the format providers/{providerId}/entitlements/{entitlement_id}. Should only be sent when resources have been migrated from entitlementMigrated to the new entitlement. Optional.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.