Developers API
Developers must register with an organization on Apigee Edge. After they are registered, developers register their apps, choose the APIs they want to use, and receive the unique API credentials (consumer keys and secrets) needed to access your APIs.
Resource Types
Attribute
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org_name}/developers | Creates a profile for a developer in an organization. After the developer is created, they can register an app and receive an API key. The developer is always created with a status of When creating a developer, you can define one or more monetization attributes as custom attributes. For more information about the monetization attributes, see Configuring monetization attributes. For example:
|
delete | /organizations/{org_name}/developers/{developer_email} | Deletes a developer from an organization. All apps and API keys associated with the developer are also removed from the organization. Note: To avoid permanently deleting developers and their artifacts, consider deactivating developers instead using the Set developer status API. Note: Developers cannot be deleted on organizations with monetization enabled. With Apigee Edge for Public Cloud, deletion of the developer and associated artifacts happens asynchronously. The developer is deleted immediately, but the resources associated with that developer, such as apps, may take anywhere from a few seconds to a few minutes to be deleted. |
get | /organizations/{org_name}/developers/{developer_email} | Gets the profile for a developer by email address. With Apigee Edge for Public Cloud, the response includes only the first 100 apps. |
put | /organizations/{org_name}/developers/{developer_email} | Update an existing developer profile. To add new values or update existing values, submit the new or updated portion of the developer profile along with the rest of the existing developer profile, even if no values are changing. To delete attributes from a developer profile, submit the entire profile without the attributes that you want to delete. Apigee Edge for Public Cloud only: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
get | /organizations/{org_name}/developers/{developer_email}/attributes | Gets developer attributes and their values. |
post | /organizations/{org_name}/developers/{developer_email}/attributes | Updates or creates developer attributes. This API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Apigee Edge for Public Cloud only: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
delete | /organizations/{org_name}/developers/{developer_email}/attributes/{attribute_name} | Deletes a developer attribute. |
get | /organizations/{org_name}/developers/{developer_email}/attributes/{attribute_name} | Gets the value of a developer attribute. |
post | /organizations/{org_name}/developers/{developer_email}/attributes/{attribute_name} | Update the value of a developer attribute. Apigee Edge for Public Cloud only: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
Attributes
Method | Endpoint | Description |
---|---|---|
get | /organizations/{org_name}/developers/{developer_email}/attributes | Gets developer attributes and their values. |
post | /organizations/{org_name}/developers/{developer_email}/attributes | Updates or creates developer attributes. This API replaces the current list of attributes with the attributes specified in the request body. This lets you update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. Apigee Edge for Public Cloud only: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
Developer
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org_name}/developers | Creates a profile for a developer in an organization. After the developer is created, they can register an app and receive an API key. The developer is always created with a status of When creating a developer, you can define one or more monetization attributes as custom attributes. For more information about the monetization attributes, see Configuring monetization attributes. For example:
|
delete | /organizations/{org_name}/developers/{developer_email} | Deletes a developer from an organization. All apps and API keys associated with the developer are also removed from the organization. Note: To avoid permanently deleting developers and their artifacts, consider deactivating developers instead using the Set developer status API. Note: Developers cannot be deleted on organizations with monetization enabled. With Apigee Edge for Public Cloud, deletion of the developer and associated artifacts happens asynchronously. The developer is deleted immediately, but the resources associated with that developer, such as apps, may take anywhere from a few seconds to a few minutes to be deleted. |
get | /organizations/{org_name}/developers/{developer_email} | Gets the profile for a developer by email address. With Apigee Edge for Public Cloud, the response includes only the first 100 apps. |
put | /organizations/{org_name}/developers/{developer_email} | Update an existing developer profile. To add new values or update existing values, submit the new or updated portion of the developer profile along with the rest of the existing developer profile, even if no values are changing. To delete attributes from a developer profile, submit the entire profile without the attributes that you want to delete. Apigee Edge for Public Cloud only: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
DeveloperRequest
Method | Endpoint | Description |
---|---|---|
post | /organizations/{org_name}/developers | Creates a profile for a developer in an organization. After the developer is created, they can register an app and receive an API key. The developer is always created with a status of When creating a developer, you can define one or more monetization attributes as custom attributes. For more information about the monetization attributes, see Configuring monetization attributes. For example:
|
put | /organizations/{org_name}/developers/{developer_email} | Update an existing developer profile. To add new values or update existing values, submit the new or updated portion of the developer profile along with the rest of the existing developer profile, even if no values are changing. To delete attributes from a developer profile, submit the entire profile without the attributes that you want to delete. Apigee Edge for Public Cloud only: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities also get cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |