Method: organizations.appgroups.apps.keys.updateAppGroupAppKey

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.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

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

  • apigee.appkeys.manage

Request body

The request body contains data with the following structure:

JSON representation 
{
  "action": string,
  "appGroupAppKey": {
    object (AppGroupAppKey)
  },
  "apiProducts": [
    string
  ]
}
Fields
action

string

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

object (AppGroupAppKey)

The new AppGroupKey to be amended. Note that the status can be updated only via action.
apiProducts[]

string

The list of API products that will be associated with the credential. This list will be appended to the existing list of associated API Products for this App Key. Duplicates will be ignored.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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