Akamai

Akamai: Identity and Access Management API

Create users and groups, and define policies that manage access to Control Center applications.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Create users and groups, and define policies that manage access
to Control Center applications.

Endpoints 96

Groups

  • GETList groups/user-admin/groups?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation lists all groups the administrator can manage for the current account and contract type or other managed accounts using the accountSwitchKey…
  • GETGet a group/user-admin/groups/:groupId?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation retrieves a group's details.
  • PUTModify a group's name/user-admin/groups/:groupId?accountSwitchKey={{accountSwitchKey}}This operation changes a group's name.
  • POSTCreate a new group/user-admin/groups/:groupId?accountSwitchKey={{accountSwitchKey}}This operation creates a new group within the specified parent group.
  • DELETEDelete a group/user-admin/groups/:groupId?accountSwitchKey={{accountSwitchKey}}This operation deletes a group. You can't delete a group that contains subgroups, resources, or users with roles on that group. You need admin access to…

Move groups

  • POSTMove a group/user-admin/groups/move?accountSwitchKey={{accountSwitchKey}}This operation moves a nested group under another group within the same parent hierarchy.
  • GETList users affected by moving a group/user-admin/groups/move/:sourceGroupId/:destinationGroupId/affected-users?userType={{userType}}&accountSwitchKey={{accountSwitchKey}}This operation lists users who are affected when you move a group. Users may lose or gain access to resources depending on the roles and permissions inherited…

Assets

  • GETList properties or includes/user-admin/properties?groupId={{groupId}}&accountSwitchKey={{accountSwitchKey}}This operation lists the properties and includes for the current account or other managed accounts using the accountSwitchKey parameter. Include the groupId…
  • GETGet a property or include/user-admin/properties/:assetId?groupId={{groupId}}&accountSwitchKey={{accountSwitchKey}}This operation fetches a property's or include's details. The response returns details for propertyId regardless of whether it represent a property or include…
  • PUTMove a property or include/user-admin/properties/:assetId?accountSwitchKey={{accountSwitchKey}}This operation moves a property or include from one group to another group. You can only move an asset into another group within the same group hierarchy.…
  • GETList users for property or include/user-admin/properties/:assetId/users?userType={{userType}}&accountSwitchKey={{accountSwitchKey}}This operation lists users who can access a property or include.
  • PUTBlock users from a property or include/user-admin/properties/:assetId/users/block?accountSwitchKey={{accountSwitchKey}}This operation blocks the users on a property or include.

Resources

  • GETGet asset's resources/user-admin/properties/:assetId/resources?groupId={{groupId}}&accountSwitchKey={{accountSwitchKey}}This operation lists resources a property or include uses to deliver your web content across Akamai's edge network. You can think of these resources as…

Roles

  • GETList roles/user-admin/roles?actions={{actions}}&groupId={{groupId}}&users={{users}}&ignoreContext={{ignoreContext}}&accountSwitchKey={{accountSwitchKey}}This operation lists roles for the current account and contract type or other accounts using the accountSwitchKey parameter. The account and contract type are…
  • POSTCreate a role/user-admin/roles?accountSwitchKey={{accountSwitchKey}}This operation creates a custom role. A custom role combines grantable roles defined by Akamai. Roles exist at the account level regardless of group, but are…
  • GETGet a role/user-admin/roles/:roleId?actions={{actions}}&grantedRoles={{grantedRoles}}&users={{users}}&accountSwitchKey={{accountSwitchKey}}This operation retrieves a role's details.
  • PUTEdit a role/user-admin/roles/:roleId?accountSwitchKey={{accountSwitchKey}}This operation adds or removes a role's group role assignments, along with other data such as name and description. When you modify a role, those changes…
  • DELETEDelete a role/user-admin/roles/:roleId?accountSwitchKey={{accountSwitchKey}}This operation deletes a custom role. You can't delete a role if it's assigned to a user.

Grantable roles

  • GETList grantable roles/user-admin/roles/grantable-roles?accountSwitchKey={{accountSwitchKey}}This operation lists the grantable roles you can include in a new custom role, or add to an existing custom role.

Users

  • GETList users/user-admin/ui-identities?groupId={{groupId}}&authGrants={{authGrants}}&actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation lists the users who have access to your current account or other managed accounts using the accountSwitchKey parameter. The account is…
  • POSTCreate a user/user-admin/ui-identities?sendEmail={{sendEmail}}&accountSwitchKey={{accountSwitchKey}}This operation creates a user, or clones an existing user's role assignments, in the account specified in your API client credentials. Optionally, sends a…
  • GETGet a user/user-admin/ui-identities/:uiIdentityId?authGrants={{authGrants}}&notifications={{notifications}}&actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation retrieves a user's profile.
  • DELETERemove a user/user-admin/ui-identities/:uiIdentityId?accountSwitchKey={{accountSwitchKey}}This operation deletes any user who doesn't own an API client. Before you delete a user with a client, transfer API client ownership to another user.
  • PUTUpdate a user/user-admin/ui-identities/:uiIdentityId/basic-info?accountSwitchKey={{accountSwitchKey}}This operation modifies a user's basic information. Pass the entire body of data in the request, including members you're not changing, or the unspecified…

Blocked assets

  • GETList blocked properties and includes/user-admin/ui-identities/:uiIdentityId/groups/:groupId/blocked-properties?accountSwitchKey={{accountSwitchKey}}This operation lists all properties and includes a user doesn't have access to in a group. Note the responses's set of IDs refer to either properties or…
  • PUTUpdate blocked properties and includes/user-admin/ui-identities/:uiIdentityId/groups/:groupId/blocked-properties?accountSwitchKey={{accountSwitchKey}}This operation updates the list of blocked properties and includes. By default, users can access all properties and includes in a group, and this operation…

User authentication settings

  • POSTLock a user's account/user-admin/ui-identities/:uiIdentityId/lock?accountSwitchKey={{accountSwitchKey}}This operation locks a user's account, preventing access to Control Center. The result shows in the user data as a read-only isLocked: true indicator. To…
  • POSTReset a user's password/user-admin/ui-identities/:uiIdentityId/reset-password?sendEmail={{sendEmail}}&accountSwitchKey={{accountSwitchKey}}This operation sends a one-time use password to the user. If you send the email with the password directly to the user, the response for this operation…
  • POSTSet a user's password/user-admin/ui-identities/:uiIdentityId/set-password?accountSwitchKey={{accountSwitchKey}}This operation sets a password for a user. This differs from Reset a user's password because this password may be used more than once, and isn't randomly…
  • POSTUnlock a user's account/user-admin/ui-identities/:uiIdentityId/unlock?accountSwitchKey={{accountSwitchKey}}This operation releases the lock on a user's account, allowing access to Control Center. The result shows in the user data as a read-only isLocked:false…
  • PUTSet multi-factor authentication for your user profile/user-profile/additionalAuthentication?accountSwitchKey={{accountSwitchKey}}This operation sets multi-factor authentication to TFA, MFA, or NONE. You have five login attempts with MFA or 2FA before your account is locked. If your…
  • PUTReset multi-factor authentication for your user profile/user-profile/additionalAuthentication/reset?accountSwitchKey={{accountSwitchKey}}This operation resets your multi-factor authentication.
  • POSTRotate your password/user-profile/change-password?accountSwitchKey={{accountSwitchKey}}This operation changes your password. Include your old password and your new password in the request body. Before you create your new password, run the View…

User access

  • PUTSet a user's multi-factor authentication/user-admin/ui-identities/:uiIdentityId/additionalAuthentication?accountSwitchKey={{accountSwitchKey}}This operation sets a user's multi-factor authentication to TFA, MFA, or NONE. Users are allowed five login attempts with MFA or 2FA before their account is…
  • PUTReset a user's multi-factor authentication/user-admin/ui-identities/:uiIdentityId/additionalAuthentication/reset?accountSwitchKey={{accountSwitchKey}}This operation prompts the reset of a user's multi-factor authentication method the next time they log in to Control Center. TFA indicates two-factor…

User notifications

  • PUTUpdate a user's notifications/user-admin/ui-identities/:uiIdentityId/notifications?accountSwitchKey={{accountSwitchKey}}This operation subscribes or unsubscribes users to product notification emails.
  • PUTUpdate your notifications/user-profile/notifications?accountSwitchKey={{accountSwitchKey}}This operation subscribes to notifications emails for password expiration reminders, proactive maintenance emails, and upgrade notification emails.

User authorization settings

  • PUTModify a user's group and role assignments/user-admin/ui-identities/:uiIdentityId/auth-grants?accountSwitchKey={{accountSwitchKey}}This operation edits what groups a user has access to, and how the user interacts with the objects in those groups.

Profile

  • GETView your profile/user-profile?authGrants={{authGrants}}&notifications={{notifications}}&actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation gets your profile information. To make changes to your profile, run the Edit your profile operation.
  • PUTEdit your profile/user-profile/basic-info?accountSwitchKey={{accountSwitchKey}}This operation updates your basic profile information, such as your name or phone number. To edit detailed settings, run the Update your notifications or…

Contact types

  • GETView contact types/user-admin/common/contact-types?accountSwitchKey={{accountSwitchKey}}This operation lists the supported contact types. Administrators should use the values from this operation to add or update a user's contactType. Users should…
  • GETView contact types for a user profile/user-profile/common/contact-types?accountSwitchKey={{accountSwitchKey}}This operation lists the supported contact types. Users should use the values from this operation to add or update their contactType. Administrators should…

Locale

  • GETView countries/user-admin/common/countries?accountSwitchKey={{accountSwitchKey}}This operation lists the supported countries. Administrators should use the values from this operation to add or update a user's country. Users should run the…
  • GETView states/user-admin/common/countries/:country/states?accountSwitchKey={{accountSwitchKey}}This operation lists the supported U.S. states or Canadian provinces. Administrators should use the values from this operation to add or update a user's…
  • GETView languages/user-admin/common/supported-languages?accountSwitchKey={{accountSwitchKey}}This operation lists the supported languages. Administrators should use the values from this operation to set a user's preferredLanguage. Users should run the…
  • GETView time zones/user-admin/common/timezones?accountSwitchKey={{accountSwitchKey}}This operation lists the supported time zones in the ISO 8601 format. Administrators should use the values from this operation to set a user's timeZone. Users…
  • GETView supported countries for a user profile/user-profile/common/countries?accountSwitchKey={{accountSwitchKey}}This operation lists the supported countries. Users should use the values from this operation to add or update their country. Administrators should run the…
  • GETView states for a user profile/user-profile/common/countries/:country/states?accountSwitchKey={{accountSwitchKey}}This operation lists the supported U.S. states or Canadian provinces. Users should use the values from this operation to add or update their state.…
  • GETView languages for a user profile/user-profile/common/supported-languages?accountSwitchKey={{accountSwitchKey}}This operation lists the supported languages. Users should use the values from this operation to set their preferred language. Administrators should run the…
  • GETView time zones for a user profile/user-profile/common/timezones?accountSwitchKey={{accountSwitchKey}}This operation lists the supported time zones in the ISO 8601 format. Users should use the values from this operation to set their timeZone. Administrators…

Products

  • GETView products/user-admin/common/notification-products?accountSwitchKey={{accountSwitchKey}}This operation lists the products a user can subscribe to and receive notifications for on the account. The tokens in your API client determine the account.…
  • GETView products for a user profile/user-profile/common/notification-products?accountSwitchKey={{accountSwitchKey}}This operation lists the products a user can subscribe to and receive notifications for on the account. The account is determined by the tokens in your API…

Policies

  • GETView password policy/user-admin/common/password-policy?accountSwitchKey={{accountSwitchKey}}This operation lists the password policy for the account. The tokens in your API client determine the account. Administrators should use the values from this…
  • GETView timeout policies/user-admin/common/timeout-policies?accountSwitchKey={{accountSwitchKey}}This operation lists the supported session timeout policies. The name for each timeout period is in minutes, and the time value is in seconds. Administrators…
  • GETView password policy for a user profile/user-profile/common/password-policy?accountSwitchKey={{accountSwitchKey}}This operation lists the password policy for the account. The account is determined by the tokens in your API client. Users should use the values from this…
  • GETView timeout policies for a user profile/user-profile/common/timeout-policies?accountSwitchKey={{accountSwitchKey}}This operation lists the supported session timeout policies. The name for each timeout period is in minutes, and the time value is in seconds. Users should…

CIDR blocks

  • GETList CIDR blocks/user-admin/ip-acl/allowlist?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation lists all CIDR blocks on your current account's allowlist or other managed accounts using the accountSwitchKey parameter. Your API client…
  • POSTCreate a CIDR block/user-admin/ip-acl/allowlist?accountSwitchKey={{accountSwitchKey}}This operation adds CIDR blocks to your account's allowlist. You can add only one CIDR block at a time. Before creating the CIDR block, you may want to…
  • GETValidate CIDR blocks/user-admin/ip-acl/allowlist/validate?cidrblock={{cidrblock}}&accountSwitchKey={{accountSwitchKey}}This operation checks the format of a potential CIDR block. If it's validated successfully, you can create it.
  • GETGet a CIDR block/user-admin/ip-acl/allowlist/:cidrBlockId?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation retrieves a CIDR block's details.
  • PUTModify a CIDR block/user-admin/ip-acl/allowlist/:cidrBlockId?accountSwitchKey={{accountSwitchKey}}This operation enables or disables an existing CIDR block, updates comments, IP addresses, or ranges in the CIDR block. Note that you can only update a CIDR…
  • DELETEDelete a CIDR block/user-admin/ip-acl/allowlist/:cidrBlockId?accountSwitchKey={{accountSwitchKey}}This operation deletes a CIDR block from the IP allowlist. After you delete a CIDR block, any requests from IP addresses you deleted fail the next time…

IP allowlists

  • POSTDisable IP allowlist/user-admin/ip-acl/allowlist/disable?accountSwitchKey={{accountSwitchKey}}This operation disables IP allowlist on your account. After you disable IP allowlist, users can access Control Center regardless of their IP address or who…
  • POSTEnable IP allowlist/user-admin/ip-acl/allowlist/enable?accountSwitchKey={{accountSwitchKey}}This operation enables IP allowlist on your account. Before you enable IP allowlist, add at least one IP address to allow access to Control Center. The…
  • GETView IP allowlist status/user-admin/ip-acl/allowlist/status?accountSwitchKey={{accountSwitchKey}}This operation indicates whether IP allowlist is enabled or disabled on your account.

Helper

  • GETList authorized users/users?accountSwitchKey={{accountSwitchKey}}This operation lists authorized API client users.
  • GETList allowed APIs/users/:username/allowed-apis?clientType={{clientType}}&allowAccountSwitch={{allowAccountSwitch}}&accountSwitchKey={{accountSwitchKey}}This operation lists available APIs for a user.
  • POSTList allowed CP codes/users/:username/allowed-cpcodes?accountSwitchKey={{accountSwitchKey}}This operation lists available CP codes for a user.
  • GETList accessible groups/users/:username/group-access?accountSwitchKey={{accountSwitchKey}}This operation lists groups available to a user.

API client: self

  • GETGet your API client/api-clients/self?actions={{actions}}&groupAccess={{groupAccess}}&apiAccess={{apiAccess}}&credentials={{credentials}}&ipAcl={{ipAcl}}&accountSwitchKey={{accountSwitchKey}}This operation provides details about your API client.
  • PUTUpdate your API client/api-clients/self?accountSwitchKey={{accountSwitchKey}}This operation updates your API client.
  • DELETEDelete your API client/api-clients/self?accountSwitchKey={{accountSwitchKey}}This operation permanently deletes an API client you own, without active credentials. It also breaks any API connections with the client. Before deleting your…
  • GETList your account switch keys/api-clients/self/account-switch-keys?search={{search}}&accountSwitchKey={{accountSwitchKey}}This operation lists account switch keys available for your API client. You can use the accountSwitchKey in many Akamai APIs to make an API call to another…
  • GETList your credentials/api-clients/self/credentials?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation lists your API client's credentials.
  • POSTCreate your credential/api-clients/self/credentials?accountSwitchKey={{accountSwitchKey}}This operation creates a new credential for your API client. Only you may create credentials for this client. Credentials are in active status at creation. By…
  • POSTDeactivate your credentials/api-clients/self/credentials/deactivate?accountSwitchKey={{accountSwitchKey}}This operation deactivates all credentials for your API client. This doesn't delete the API client or the credentials. To deactivate a single credential, run…
  • GETGet your credential/api-clients/self/credentials/:credentialId?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation provides details about a specific credential for your API client. To change the credential's expiration date or toggle its activation status,…
  • PUTUpdate your credential/api-clients/self/credentials/:credentialId?accountSwitchKey={{accountSwitchKey}}This operation updates a specific credential for your API client. You can change the expiration date, description, or toggle the activation status. This isn't…
  • DELETERemove your credential/api-clients/self/credentials/:credentialId?accountSwitchKey={{accountSwitchKey}}This operation deletes a specific credential from your API client. You can only delete inactive credentials.
  • POSTDeactivate your credential/api-clients/self/credentials/:credentialId/deactivate?accountSwitchKey={{accountSwitchKey}}This operation deactivates a specific credential for your API client. This doesn't delete the client or the credentials. To update a specific credential, run…
  • PUTLock your API client/api-clients/self/lock?accountSwitchKey={{accountSwitchKey}}This operation locks your API client. You can't use the API client while it's locked. To unlock your client, run the Unlock an API client operation.

API clients

  • GETList API clients/api-clients?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation lists API clients an administrator can manage on the current account or other managed accounts using the accountSwitchKey parameter.
  • POSTCreate an API client/api-clients?accountSwitchKey={{accountSwitchKey}}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…
  • GETGet an API client/api-clients/:clientId?actions={{actions}}&groupAccess={{groupAccess}}&apiAccess={{apiAccess}}&credentials={{credentials}}&ipAcl={{ipAcl}}&accountSwitchKey={{accountSwitchKey}}This operation provides details about an API client.
  • PUTUpdate an API client/api-clients/:clientId?accountSwitchKey={{accountSwitchKey}}This operation updates an API client.
  • DELETEDelete an API client/api-clients/:clientId?accountSwitchKey={{accountSwitchKey}}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…
  • GETList account switch keys/api-clients/:clientId/account-switch-keys?search={{search}}&accountSwitchKey={{accountSwitchKey}}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…
  • GETList credentials/api-clients/:clientId/credentials?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}This operation lists credentials for an API client.
  • POSTCreate a credential/api-clients/:clientId/credentials?accountSwitchKey={{accountSwitchKey}}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…
  • POSTDeactivate credentials/api-clients/:clientId/credentials/deactivate?accountSwitchKey={{accountSwitchKey}}This operation deactivates all credentials for a specific API client. This doesn't delete the API client or the credentials. To deactivate a single…
  • GETGet a credential/api-clients/:clientId/credentials/:credentialId?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}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…
  • PUTUpdate a credential/api-clients/:clientId/credentials/:credentialId?accountSwitchKey={{accountSwitchKey}}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…
  • DELETERemove a credential/api-clients/:clientId/credentials/:credentialId?accountSwitchKey={{accountSwitchKey}}This operation deletes a specific credential from an API client. You can only delete inactive credentials.
  • POSTDeactivate a credential/api-clients/:clientId/credentials/:credentialId/deactivate?accountSwitchKey={{accountSwitchKey}}This operation deactivates a specific credential for an API client. This doesn't delete the API client, or the other credentials.
  • PUTLock an API client/api-clients/:clientId/lock?accountSwitchKey={{accountSwitchKey}}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.
  • PUTUnlock an API client/api-clients/:clientId/unlock?accountSwitchKey={{accountSwitchKey}}This operation unlocks an API client.

API details

Base URL
https://{hostname}/identity-management/v3
Authentication
None declared in the description
Operations
96 operations on 72 pathsGET 46PUT 22POST 20DELETE 8
Main resources
API clients 15API client: self 12Locale 8User authentication settings 7CIDR blocks 6Assets 5Groups 5Roles 5Users 5Helper 4
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 3

How to test the Akamai: Identity and Access Management API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Identity and Access Management API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List groups” (GET /user-admin/groups?actions={{actions}}&accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Identity and Access Management API?

Create users and groups, and define policies that manage access to Control Center applications. It is listed under Developer tools and has 96 endpoints.

Who publishes the Akamai: Identity and Access Management API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Identity and Access Management API?

Requests go to https://{hostname}/identity-management/v3. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Identity and Access Management API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: Identity and Access Management API have?

96 operations on 72 paths (46 GET, 22 PUT, 20 POST, 8 DELETE). The largest groups are API clients, API client: self, Locale, User authentication settings.

Is forking the Akamai: Identity and Access Management API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.