1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Apigee
  7. \
  8. Resource
  9. \
  10. OrganizationsAppgroupsAppsKeysApiproducts

OrganizationsAppgroupsAppsKeysApiproducts

class OrganizationsAppgroupsAppsKeysApiproducts extends Resource (View source)

The "apiproducts" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apiproducts = $apigeeService->organizations_appgroups_apps_keys_apiproducts;

Methods

GoogleCloudApigeeV1AppGroupAppKey
delete(string $name, array $optParams = [])

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product.

GoogleProtobufEmpty
updateAppGroupAppKeyApiProduct(string $name, array $optParams = [])

Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API. (apiproducts.updateAppGroupAppKeyApiProduct)

Details

at line 46
GoogleCloudApigeeV1AppGroupAppKey delete(string $name, array $optParams = [])

Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product.

Note: The consumer key is not removed, only its association with the API product. (apiproducts.delete)

Parameters

string $name

Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_grou p_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupAppKey

Exceptions

Exception

at line 71
GoogleProtobufEmpty updateAppGroupAppKeyApiProduct(string $name, array $optParams = [])

Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to revoked will not allow access to the API. (apiproducts.updateAppGroupAppKeyApiProduct)

Parameters

string $name

Required. Name of the API product in the developer app key in the following format: organizations/{org}/appgroups/{app_group_name}/ apps/{app}/keys/{key}/apiproducts/{apiproduct}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception