Identity and Access Management API v3 Migration
The Identity and Access Management API v3 includes all operation endpoints from the v1 and v2 APIs. The API v3 lets you manage your API clients and client credentials, and lets account administrators perform a variety of tasks, such as create, update, delete, lock, and unlock API clients. In addition, the API v3 offers Akamai MFA, providing users with a strong secondary authentication method.
As of September 30, 2025, the Identity and Access Management API v1 and API v2 will be officially decommissioned, and Akamai will no longer support the v1 and v2 APIs. Make sure you migrate your API v1 and v2 requests to the latest API v3 before this date.
To migrate your existing API v1 requests to v3, see the endpoints listed in the API v1 to API v3 Migration table.
To migrate your existing API v2 requests to v3, see the endpoints listed in the API v2 to API v3 Migration for Akamai MFA table.
If you have questions or need assistance, contact your Control Center Administrator.
API v1 to API v3 Migration
This table shows the API v1 operation endpoints that you change in your request to migrate to the API v3:
| API v1 Operation | Change v1 Endpoint | To v3 Endpoint |
|---|---|---|
| List account switch keys (GET) | /identity-management/v1/open-identities/{openIdentityId}/account-switch-keys | /identity-management/v3/api-clients/{clientId}/account-switch-keys |
| List credentials (GET) | /identity-management/v1/open-identities/{openIdentityId}/credentials | /identity-management/v3/api-clients/{clientId}/credentials |
| Create a credential (POST) | /identity-management/v1/open-identities/{openIdentityId}/credentials | /identity-management/v3/api-clients/{clientId}/credentials |
| Deactivate all credentials (POST) | /identity-management/v1/open-identities/{openIdentityId}/credentials/deactivate | /identity-management/v3/api-clients/{clientId}/credentials/deactivate |
| Remove a credential (DELETE) | /identity-management/v1/open-identities/{openIdentityId}/credentials/{credentialId} | /identity-management/v3/api-clients/{clientId}/credentials/{credentialId} |
| Get a credential (GET) | /identity-management/v1/open-identities/{openIdentityId}/credentials/{credentialId} | /identity-management/v3/api-clients/{clientId}/credentials/{credentialId} |
| Update a credential (PUT) | /identity-management/v1/open-identities/{openIdentityId}/credentials/{credentialId} | /identity-management/v3/api-clients/{clientId}/credentials/{credentialId} |
API v2 to API v3 Migration for Akamai MFA
If you don’t plan to use Akamai MFA, you can disregard this section.
The API v3 includes the additionalAuthentication attribute for Akamai MFA. It specifies the user's multi-factor authentication method, confirming their identity. After migrating to API v3, you need to include additionalAuthentication in the payload of your API requests where appropriate in these endpoints:
| API v2 Operation | Change v2 Endpoint | To v3 Endpoint |
|---|---|---|
| Create a user (POST) | /identity-management/v2/user-admin/ui-identities | /identity-management/v3/user-admin/ui-identities |
| List users (GET) | /identity-management/v2/user-admin/ui-identities | /identity-management/v3/user-admin/ui-identities |
| Get a user (GET) | /identity-management/v2/user-admin/ui-identities/{uiIdentityId} | /identity-management/v3/user-admin/ui-identities/{uiIdentityId} |
| Update a user (PUT) | /identity-management/v2/user-admin/ui-identities/{uiIdentityId}/basic-info | /identity-management/v3/user-admin/ui-identities/{uiIdentityId}/basic-info |
| View your profile (GET) | /identity-management/v2/user-profile | /identity-management/v3/user-profile |
| Edit your profile (PUT) | /identity-management/v2/user-profile/basic-info | /identity-management/v3/user-profile/basic-info |
| Set two-factor authentication (PUT) | /identity-management/v2/user-profile/tfa | /identity-management/v3/user-profile/additionalAuthentication |
| Set a user's two-factor authentication (PUT) | /identity-management/v2/user-admin/ui-identities/{uiIdentityId}/tfa | /identity-management/v3/user-admin/ui-identities/{uiIdentityId}/additionalAuthentication |
| Reset a user's multi-factor authentication (PUT) | /identity-management/v2/user-admin/ui-identities/{uiIdentityId}/tfa?action=reset | /identity-management/v3/user-admin/ui-identities/{uiIdentityId}/additionalAuthentication/reset |
| Reset multi-factor authentication for a user profile (PUT) | /identity-management/v2/user-profile/tfa?action=reset | /identity-management/v3/user-profile/additionalAuthentication/reset |