These docs are for v1. Click to read the latest docs for v3.

To configure this API for the first time:

  • If you do not already have an API client, create one in Akamai Control Center through the Manage APIs app.

  • This API requires an openIdentityId. The openIdentityId is visible in the credential details section of the OPEN Identity details page. To retrieve the ID:

    1. In Control Center, navigate to the API Client detail page.

    2. Retrieve the ID from underneath API Client name.

    3. Insert the ID in each operation where applicable.

  • Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this:
  • To enable this API, choose the API service named Identity Management: API, and set the access level to READ-WRITE.

The code examples in this API reference don't contain the required authentication code syntax you need to make API calls. To learn how to apply authentication in a variety of programming languages when using Akamai APIs, see Authenticate with EdgeGrid.


Provide feedback or ask a question in the developer community. You can also contact your ‚ÄčAkamai‚Äč account representative for support. We want to hear from you!