class OrganizationsAppgroupsAppsKeys extends Resource (View source)

The "keys" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $keys = $apigeeService->organizations_appgroups_apps_keys;

Methods

create(string $parent, GoogleCloudApigeeV1AppGroupAppKey $postBody, array $optParams = [])

Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.

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

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. (keys.delete)

get(string $name, array $optParams = [])

Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information. (keys.get)

updateAppGroupAppKey(string $name, GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest $postBody, array $optParams = [])

Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

Details

GoogleCloudApigeeV1AppGroupAppKey create(string $parent, GoogleCloudApigeeV1AppGroupAppKey $postBody, array $optParams = [])

Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.

To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. Note: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the ProductizeAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API. (keys.create)

Parameters

string $parent

Required. Parent of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys

GoogleCloudApigeeV1AppGroupAppKey $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupAppKey

Exceptions

Exception

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

Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs. (keys.delete)

Parameters

string $name

Required. Name of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupAppKey

Exceptions

Exception

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

Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information. (keys.get)

Parameters

string $name

Required. Name of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupAppKey

Exceptions

Exception

GoogleCloudApigeeV1AppGroupAppKey updateAppGroupAppKey(string $name, GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest $postBody, array $optParams = [])

Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.

(keys.updateAppGroupAppKey)

Parameters

string $name

Required. Name of the AppGroup app key. Use the following structure in your request: organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}

GoogleCloudApigeeV1UpdateAppGroupAppKeyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1AppGroupAppKey

Exceptions

Exception