API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
| API Resource Path: /developers/{developer_email}/apps/{app_name}/keys |
| Consumer credentials (also known as "API keys" or "app keys") generated, provisioned, and managed by the API Platform for apps associated with individual developers. |
| Credential pairs consisting of consumer key and consumer secret provisioned by Apigee to apps for specific API products. Apigee maintains the relationship between consumer keys and API products, enabling APi products to be added to and removed from consumer keys. A single consumer key can be used to access multiple API products. Keys may be manually or automatically approved for API products--how they are issued depends on the API product configuration. A key must approved and approved for an API product to be capable of accessing any of the URIs defined in the API product. |
| Approve a developer app key | Detail | |
/developers/{developer_emal}/apps/{app_name}/keys/{consumer_key} | ||
| Verb: | POST | |
| Description: | Changes the status of a consumer key from 'pending' to 'approved' | |
| Content Types: |
application/x-www-url-form-encoded
| |
| Auth: | Basic Auth | |
| Approve API Product for the Key of Developer App | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name} | ||
| Verb: | POST | |
| Description: | Approves the association of a Developer App's consumer key with an API Product | |
| Auth: | Basic Auth | |
| Delete a Developer App Key | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} | ||
| Verb: | DELETE | |
| Description: | Deletes a consumer key that belongs to an app. | |
| Auth: | Basic Auth | |
| Delete API product from a developer app key profile | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name} | ||
| Verb: | DELETE | |
| Description: | Removes an API product from a developer app key profile, and thereby renders the developer app unable to access the URIs defined the API product that was removed. | |
| Content Types: |
application/json
text/xml
| |
| Auth: | Basic Auth | |
| Get a specific Key of Developer App | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} | ||
| Verb: | GET | |
| Description: | Returns details for a consumer key for a developer app | |
| Auth: | Basic Auth | |
| Revoke a Developer App Key | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} | ||
| Verb: | POST | |
| Description: | Revokes a developer app key | |
| Auth: | Basic Auth | |
| Revoke API product association with a specific developer app key | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}?action=revoke | ||
| Verb: | POST | |
| Description: | Revokes the association of an API Product with a Developer App's consumer key. | |
| Auth: | Basic Auth | |
| Update Key with ApiProduct(s) | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} | ||
| Verb: | POST | |
| Description: | Adds an API product to a developer app key | |
| Auth: | Basic Auth | |
