API clients
Number of APIs: 15
POST https://{{host}}/identity-management/v3/api-clients
This operation creates a new API client. Optionally, you can automatically assign a credential for the client when you create it. If you choose not to assign the credential automatically, see Create authentication credentials for details.
GET https://{{host}}/identity-management/v3/api-clients
This operation lists API clients an administrator can manage on the current account or other managed accounts using the accountSwitchKey parameter.
GET https://{{host}}/identity-management/v3/api-clients/:clientId
This operation provides details about an API client.
PUT https://{{host}}/identity-management/v3/api-clients/:clientId
This operation updates an API client.
DELETE https://{{host}}/identity-management/v3/api-clients/:clientId
This operation permanently deletes the API client, breaking any API connections with the client. To delete a client, you need to own the client, or have admin access on a given group. Before deleting an API client, make sure there aren't any API integrations or scripts using it.
GET https://{{host}}/identity-management/v3/api-clients/:clientId/account-switch-keys
This operation lists account switch keys available for a specific API client. The client can use the accountSwitchKey in many Akamai APIs to make an API call to another account.
POST https://{{host}}/identity-management/v3/api-clients/:clientId/credentials
This operation creates a new credential for your API client. If you don't know your clientId, you can run the Create your credential operation. Credentials are in active status at creation. By default, they expire two years from their creation date. However, when the API client's permissions are based on Control Center permissions, credentials expire differently and follow the same rotation schedule listed for user passwords on those accounts. Run the Update a credential operation to change the expiration date, description, or status. Save the values from the response, such as the credentialID, for future use. This is the only time you'll see the client secret. Save the credential to avoid the need to create a new one.
GET https://{{host}}/identity-management/v3/api-clients/:clientId/credentials
This operation lists credentials for an API client.
POST https://{{host}}/identity-management/v3/api-clients/:clientId/credentials/deactivate
This operation deactivates all credentials for a specific API client. This doesn't delete the API client or the credentials. To deactivate a single credential, run either the Deactivate a credential operation or Update a credential and set the status to INACTIVE.
10. Get a credential
GET https://{{host}}/identity-management/v3/api-clients/:clientId/credentials/:credentialId
This operation returns details about a specific credential for an API client. To change the credential's expiration date or toggle its activation status, run the Update credential for an API client operation.
PUT https://{{host}}/identity-management/v3/api-clients/:clientId/credentials/:credentialId
This operation updates a specific credential for an API client. You can change the expiration date, description, or toggle the activation status. This isn't the same as rotating a credential. For details, see Rotate credentials.
DELETE https://{{host}}/identity-management/v3/api-clients/:clientId/credentials/:credentialId
This operation deletes a specific credential from an API client. You can only delete inactive credentials.
POST https://{{host}}/identity-management/v3/api-clients/:clientId/credentials/:credentialId/deactivate
This operation deactivates a specific credential for an API client. This doesn't delete the API client, or the other credentials.
PUT https://{{host}}/identity-management/v3/api-clients/:clientId/lock
This operation locks an API client. You can't use the API client while it's locked. To unlock a client, run the Unlock an API client operation.
PUT https://{{host}}/identity-management/v3/api-clients/:clientId/unlock
This operation unlocks an API client.
ENDPOINTS