Company apps API

download spec authorize
Company apps API
CompanyApp

CompanyApp

Company app details.

Schema

CompanyApp
appFamily

string

Output only. App family.

appId

string

Output only. ID of the app.

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.

object
name

string

value

string

callbackUrl

string

Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.

companyName

string

Output only. Name of the company.

createdAt

integer (int32)

Output only. Time the app was created in milliseconds since epoch.

createdBy

string

Output only. Email address of the developer that created the app.

credentials

array

Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.

object
apiProducts

array

List of API products.

attributes

array

List of attributes.

consumerKey

string

Consumer API key.

consumerSecret

string

Consumer secret.

expiresAt

integer (int32)

Time the credentials expire in milliseconds since epoch.

issuedAt

integer (int32)

Time the credentials were issued in milliseconds since epoch.

scopes

array

OAuth scopes.

status

string

Status of the credentials.

lastModifiedAt

integer (int32)

Output only. Last modified time as milliseconds since epoch.

lastModifiedBy

string

Output only. Email of developer that last modified the app.

name

string

Name of the company app. Required when creating a company app; not required when updating a company app. The name becomes the unique ID of the app for this organization and company. 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.

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.

Paths

The following paths use this type:

/organizations/{org_name}/companies/{company_name}/apps/post

Creates an app associated with a company, 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. You must create a profile for the company in your organization before you can register apps that are associated with the company.

Ensure optimal API product and app security

An organization-level property, features.keymanagement.disable.unbounded.permissions, strengthens the security of API products in verifying API calls. When the property is set to true, the following features are enforced.

  • App creation: When creating a developer or company app, the Edge API requires that the app be associated with an API product. (The Edge UI already enforces this.)

  • API product configuration: To create or update an API product, the API product must include at least one API proxy or a resource path in its definition.

  • Runtime security: API calls are rejected by an API product in the following situations:

    • An API product doesn't include at least one API proxy or resource path.

    • If the flow.resource.name variable in the message doesn't include a resource path that the API product can evaluate.

    • If the app making the API call isn't associated with an API product.

Note: Setting this organization property requires system administrator rights. Edge for Private Cloud system administrators can make add this property on their own with the Update organization properties API. If you are an Edge for Public Cloud user and the previously described restrictions are not in place, contact Apigee Support to set the organization property for you.

/organizations/{org_name}/companies/{company_name}/apps/{app_name}/delete

Deletes a company app.

/organizations/{org_name}/companies/{company_name}/apps/{app_name}/get

Gets the profile for a company app.

/organizations/{org_name}/companies/{company_name}/apps/{app_name}/put

Updates an existing company app. Note: You must include all current attribute, API product, and callback values in the payload along with any changes you want to make; otherwise, the existing values are removed. To display the current values, see Get the company app API.