Company App Keys API

download spec authorize

Company App Keys API

Manage consumer credentials (also known as "API keys" or "app keys") that are generated, provisioned, and managed by Apigee Edge for apps associated with company entities.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

Keys

For more information, see Keys.
MethodEndpointDescription
post/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/create

Creates a custom consumer key and secret for a company app. This is particularly useful if you want to migrate existing consumer keys/secrets to Edge from another system.

After creating the consumer key and secret, associate the key with an API product, as described in Add API Product to Key.

Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed.

Note: Be aware of the following size limits on API keys. By staying within these limits, you help avoid service disruptions.

  • Consumer key (API key) size: 2 KB
  • Consumer secret size: 2 KB

If a consumer key and secret already exist, you can either keep them or delete them, as described in Delete Key for a Developer App.

In addition, you can use this API if you have existing API keys and secrets that you want to copy into Edge from another system. For more information, see Import existing consumer keys and secrets.

delete/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Deletes a key for a company app and removes all API products associated with the app. The key can no longer be used to access any APIs.

get/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Get key information for a company app

post/organizations/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Enables you to perform one of the following tasks:

  • Add an API product to a company app key, enabling the app that holds the key to access the API resources bundled in the API product. You can also use this API to add attributes to the key. You must include all existing attributes, whether or not you are updating them, as well as any new attributes that you are adding. After adding the API product, you can use the same key to access all API products associated with the app.

  • Approve or revoke a specific consumer key for an app. Call the API with the action query parameter set to approve or revoke (with no request body) and set the Content-type header to application/octet-stream. If successful, the HTTP status code for success is: 204 No Content Currently, this action cannot be executed using the Try this API panel.

You can approve a consumer key that is currently revoked or pending. Once approved, the app can use the consumer key to access APIs. Revoking a consumer key renders it unusable for the app to use to access an API. An app with an unapproved key cannot access any API products and cannot invoke any APIs managed by Apigee Edge. Note: Any access tokens associated with a revoked app key will remain active. However, Apigee Edge checks the status of the app key and if set to revoked it will not allow API calls to go through.