Company apps API

A consumer/client app associated with a company entity. For more information, see Register apps and manage API keys.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

CompanyApp

For more information, see CompanyApp.
MethodEndpointDescription
post/organizations/{org_name}/companies/{company_name}/apps

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.

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

Deletes a company app.

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

Gets the profile for a company app.

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

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.

CompanyAppRequest

For more information, see CompanyAppRequest.
MethodEndpointDescription
post/organizations/{org_name}/companies/{company_name}/apps

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.

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

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.

CompanyApps

For more information, see CompanyApps.
No methods use this type.