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.


You will need authorization for the scope to make a valid call.

If unset, the scope for this method defaults to You can set the scope for this method like this: apigee1 --scope <scope> organizations appgroups-apps-keys-update-app-group-app-key ...

Required Scalar Argument

  • <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}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

  action: string
  api-products: [string]
    consumer-key: string
    consumer-secret: string
    expires-at: string
    expires-in-seconds: string
    issued-at: string
    scopes: [string]
    status: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . action=stet
    • 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.
  • api-products=dolores
    • 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.
    • Each invocation of this argument appends the given value to the array.
  • app-group-app-key consumer-key=eos
    • Immutable. Consumer key.
  • consumer-secret=et
    • Secret key.
  • expires-at=sea
    • Output only. Time the AppGroup app expires in milliseconds since epoch.
  • expires-in-seconds=et
    • Immutable. Expiration time, in seconds, for the consumer key. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
  • issued-at=at
    • Output only. Time the AppGroup app was created in milliseconds since epoch.
  • scopes=dolore
    • Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
    • Each invocation of this argument appends the given value to the array.
  • status=eirmod
    • Status of the credential. Valid values include approved or revoked.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").