Send Docs Feedback

Create Developer App

Resource Summary

Security

Content Type

application/json, text/xml

Category

Developer App,

createDeveloperApp

POST

Create Developer App

Creates an app associated with a developer, associates the app with an API product, and auto-generates an API key for the app to use in calls to API proxies inside the API product.

 

The name is the unique ID of the app that you can use in management API calls. The DisplayName (set with an attribute) is what appears in the management UI. If you don't provide a DisplayName, the name is used.

 

The keyExpiresIn property sets the expiration on the API key. If you don't set this, or set the value to -1, they API key never expires.

 

CPS: With Core Persistence Services, the custom attribute limit is 18.

 

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/developers/{developer_email_or_id}/apps

Header Parameters

Name Values Description

Specify Content Type.

Request Body

Name Description Default Required?
name The name of the app. The name becomes the unique ID of the app for this organization and developer. Names must begin with an alphanumeric character and can contain letters, numbers, spaces, and the following characters: . _ # - $ %. While you can use spaces in the name, you should instead use camel case, underscores, or hyphens. Otherwise, you will have to URL encode the app name when you need to include it in the URL of other Edge API calls. For example, when getting app details by using the Get Developer App Details API. N/A Yes
apiProducts A list of API products with which the app is associated. The name (not the displayName) of the API product is the name returned by a GET request to the "List API Products" endpoint. N/A No
keyExpiresIn A setting, in milliseconds, for the lifetime of the consumer key that will be generated for the developer app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. -1 No
status If you exclude this property, the developer app status is automatically set to approved. But you can set an app's initial app status to revoked. If an app is revoked, none of its API keys are valid for API calls until the status is Approved. You can change app status in the management UI or with the Approve or Revoke Developer App API. approved No
scopes The scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. N/A No
attributes Name/value pairs that may be used for customizing profile information or for app-specific processing.
  • DisplayName (see the sample request body) is an attribute that provides the app name in the Edge management UI. This can be different from the name (unique ID) of the app.
  • The Notes attribute lets you add notes about the developer app.
  • Any other arbitrary name/value pairs you create are included as custom attributes.
N/A No
callbackUrl The callbackUrl is used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. See the documentation on OAuth 2.0 for more details. N/A No, with the exception of 3-legged OAuth 2.0.

org_name Mention the organization name true

developer_email_or_id Mention the developer email or ID true

org_name Mention the organization name true

developer_email Mention the developer email true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Elements

Name Description
createdAt Unix time when the app was created
createdBy User name of the Apigee developer 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
keyExpiresIn A setting, in milliseconds, for the lifetime of the consumer key that will be generated for the developer app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated.
status The status of the API product association: 'approved' or 'pending'
attributes Name/value pairs used to extend the default app profile
consumerKey The value of the consumer key for the app
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 the Apigee developer who last modified the app
name Name of the app. The name is the unique ID of the app for this organization and developer.
status Status of the app: 'approved' or 'revoked'. You can change the developer status in the management UI or with the Approve or Revoke Developer App API.
attributes Name/value formatted attributes used to extend the default profile
callbackUrl The callbackUrl is used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. CallbackUrl must match the value of redirect_uri in some OAuth 2.0 See the documentation on OAuth 2.0 for more details.
application/xml

Working...

Help or comments?