Developer apps API

download spec authorize

DeveloperAppRequest

Developer app request.

Schema

DeveloperAppRequest
apiProducts

array

List of API products to which the app is associated (when creating or updating an app). The name of the API product is the name returned when you list API products. For example, if the Display Name of the API product in the Edge UI is Premium API Product, then the name is premium-api-product (all lowercase with spaces replaced by hyphens). You can add API products later when you update the developer app. Existing API products are listed in the credentials array.

attributes

array

List of attributes used for customizing profile information or for app-specific processing. With Apigee Edge for Public Cloud, the custom attribute limit is 18. Note the folowing:

  • DisplayName is an attribute that provides the app name in the Edge UI. This can be different from the name (unique ID) of the app.
  • Notes attribute lets you add notes about the developer app.
  • Any other arbitrary name/value pairs you create are included as custom attributes.
Attribute

Developer app attribute name and value.

name

string

Name of attribute.

value

string

Value of attribute.

callbackUrl

string

Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. See the OAuth 2.0 documentation for more details.

keyExpiresIn

integer (int32)

Lifetime of the consumer key that will be generated for the developer app, in milliseconds. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated.

name (required)

string

Name of the developer app. Required when creating a developer app; not required when updating a developer app.

The name is used to uniquely identify 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, we recommend that you use camel case, underscores, or hyphens instead. Otherwise, you will have to URL-encode the app name when you need to include it in the URL of other Edge API calls. See the naming restrictions.

scopes

array

Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.

status

string

Status of the credential.