Method: organizations.developers.apps.keys.updateDeveloperAppKey

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product.

In addition, you can add attributes and scopes associated with the API product to the developer app key. The status of the key can be updated via "action" Query Parameter. None of the other fields can be updated via this API. 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. None of the other fields can be updated.

You can use the same key to access all API products associated with the app.

HTTP request

POST https://apigee.googleapis.com/v1/{name=organizations/*/developers/*/apps/*/keys/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Name of the developer app key. Use the following structure in your request: organizations/{org}/developers/{developerEmail}/apps/{app}/keys/{key}

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

  • apigee.appkeys.manage

Query parameters

Parameters
action

string

Approve or revoke the consumer key by setting this value to approve or revoke, respectively. The Content-Type header must be set to application/octet-stream.

Request body

The request body contains an instance of DeveloperAppKey.

Response body

If successful, the response body contains an instance of DeveloperAppKey.

Authorization scopes

Requires the following OAuth scope:

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