Create app for a company

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

API Resource Path: /companies/{company_name}/apps

Creates an App for a Company

Verb: POST

Auth: Basic Auth

Creates an app that belongs to a company.

Sample Request: 
$ curl -H "Content-type:application/json" -X POST -d \
'{
  "accessType" : "read",
  "attributes" : [ {
    "name" : "Language",
    "value" : "java"
  } ],
  "apiProducts": [ "TestApiProduct"],
  "callbackUrl" : "www.apigee.com",
  "name" : "sandboxTestApp"
}' \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies/{company_name}/apps \
-u myname:mypass
Request Payload Elements:
Name Description Default Required?
accessType Acces type for the app (unused by Apigee) No
attributes Name/value formatted attributes used to extend the default profile No
apiProducts Any API Products the app consumes No
callbackUrl A URL atht can be used for app specific callbacks Yes
name Name of the app Yes
Sample Response: 
{
  "accessType" : "read",
  "attributes" : [ {
    "name" : "Language",
    "value" : "java"
  } ],
  "callbackUrl" : "www.apigee.com",
  "createdAt" : 1343050516114,
  "createdBy" : "Admin",
  "credentials" : [ {
    "apiProducts" : [ {
      "apiproduct" : "TestApiProduct",
      "status" : "approved"
    } ],
    "attributes" : [ ],
    "consumerKey" : "N6S0jcOhgbsCJD3B7EGNFo0FYAZSpCez",
    "consumerSecret" : "BCJpVuK3uq9VuEgK",
    "status" : "approved"
  } ],
  "lastModifiedAt" : 1343050516114,
  "lastModifiedBy" : "Admin",
  "name" : "sandboxTestApp",
  "status" : "approved"
}
Response Payload Elements:
Name Description
accessType
attributes Name/value pairs used to extend the default profile
callbackUrl If set, the Oauth policy will not provide an access token unless the redirect_uri in the request matches the value of the callback in the app
createdAt Unix time when the app was created
createdBy User name of the Apigee user who created the app
credentials A set of credentials for the app--credentials are app key/secret pairs associated with API products
apiProducts A list of API products with which the app is associated
apiproduct Name of the API product
status The status of the association between the API product and the consumer key: 'approved' or 'unapproved'
attributes Name/value pairs used to extend the default profile
consumerKey The value of the consumer key
consumerSecret The value of the consumer secret associated with the consumer key
status The status of the consumer key: 'approved' or 'pending'
lastModifiedAt Unix time when the app was last modified
lastModifiedBy User name of teh Apigee user who last modified the app
name Name of the app
status Status of the app: 'approved' or 'unapproved'
Errors 
Failure 4xx with proper error message
{
  "code" : "keymanagement.service.app_invalid_name",
  "message" : "Invalid App Name",
  "contexts" : [ ]
}
Last updated: about 1 month ago