Was this helpful?

 

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/companies/{company_name}/apps/{app_name}/keys/{consumer_key}

Description: Gets the consumer key issued to a company app

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml

Overview: Fetch a specific key for a company app

Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies/{company_name}/apps/{app_name}/keys/{consumer_key} \
-u myname:mypass
Sample Response:
{
  "apiProducts" : [ {
    "apiproduct" : "TestApiProduct1",
    "status" : "approved"
  }, {
    "apiproduct" : "TestApiProduct2",
    "status" : "approved"
  } ],
  "attributes" : [ {
    "name" : "region",
    "value" : "west"
  } ],
  "consumerKey" : "{consumerkey}",
  "consumerSecret" : "{consumerSecret}",
  "status" : "approved"
}
Response Payload Elements:
Name Description
apiProducts API products with which the company app key is associated
status The status of the association between the company app key and the API product
attributes Name/value pair attributes used to extend the default company app key profile
consumer key The value of the consumer key
consumer secret The consumer secret associated with the consumer key
status The status of the consumer key: 'approved' or 'unapproved'
Errors:
{
  "code" : "keymanagement.service.InvalidClientIdForGivenApp",
  "message" : "Invalid consumer key for Given App",
  "contexts" : [ ]
}

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)