Company apps API
A consumer/client app associated with a company entity. For more information, see Register apps and manage API keys.
Resource Types
CompanyApp
Method | Endpoint | Description |
---|---|---|
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,
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
Method | Endpoint | Description |
---|---|---|
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,
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. |