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" : [ ]
}

 

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.