The Identity Management: User Administration API

Identity Management: User Administration API lets administrators programmatically manage users and their access to Akamai applications and resources. Additionally, administrators can programmatically maintain user accounts and other general user information, manage groups and group access, and perform other administrative tasks.

If you are not an administrator, you can use a part of this API to update your own profile information, or move groups and properties provided you have the proper role assignments to do so.

To manage API clients, see Identity Management API.

NOTE: This most recent API version 2 supersedes the earlier version 1. Upgrade to this new version of the API at your earliest opportunity. See User Admin API for the older API.

Who Should Use This API

Account administrators should use this API to perform tasks to or for other users in addition to all tasks regular users perform.

Users, or non-administrators, can use this API to manage groups, create or update roles, edit their own information, or move properties between groups. Users can also block property access to other users.

Getting Started

  • Review Get Started on tools that Akamai provides for all its APIs.

  • First-time users need to create an API client with access to the Identity Management: User Administration API through the Identity Management application in Luna Control Center. Alternatively, administrators can create an API client for themselves in the Identity Management application in Luna, and then change the owner of the client from themselves to another user.

  • Review Authorize Your Client to create your API access credentials and authorizations. As detailed in the API Identity Model section, you then access the API using custom hostnames that looks like this:

  • Review the Authorize Your Client section to make sure the identity under which you provision the API can access its full range of functionality. Use the Identity Management application to expand access if necessary, or the Identity Management API as a programmatic alternative.

Last modified: 11/14/2017