Apigee API . organizations . developers . apps . keys . apiproducts

Instance Methods

delete(name, x__xgafv=None)

Removes an API product from an app's consumer key. After the API product is

updateDeveloperAppKeyApiProduct(name, action=None, x__xgafv=None)

Approve or revoke an app's consumer key. After a consumer key is approved,

Method Details

delete(name, x__xgafv=None)
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.

Args:
  name: string, Name of the API product in the developer app key in the following
format:
  `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "scopes": [ # Scopes to apply to the app. The specified scope names must already
          # be defined for the API product that you associate with the app.
        "A String",
      ],
      "consumerKey": "A String", # Consumer key.
      "apiProducts": [ # List of API products for which the credential can be used.
          #
          # **Note**: Do not specify the list of API products when creating a consumer
          # key and secret for a developer app. Instead, use the
          # UpdateDeveloperAppKey API to
          # make the association after the consumer key and secret are created.
        "",
      ],
      "attributes": [ # List of attributes associated with the credential.
        { # Key-value pair to store extra metadata.
          "value": "A String", # Value of the attribute.
          "name": "A String", # API key of the attribute.
        },
      ],
      "issuedAt": "A String", # Time the developer app was created in milliseconds since epoch.
      "expiresAt": "A String", # Time the developer app expires in milliseconds since epoch.
      "consumerSecret": "A String", # Secret key.
      "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
    }
updateDeveloperAppKeyApiProduct(name, action=None, x__xgafv=None)
Approve or revoke an app's consumer key. 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 hybrid checks the status of the consumer key and
if set to `revoked` will not allow access to the API.

Args:
  name: string, Name of the API product in the developer app key in the following
format:
  `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}` (required)
  action: string, Approve or revoke the consumer key by setting this value to
`approve` or `revoke`, respectively.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }