As a new customer, you work with your Akamai account team to set up several things you'll need to onboard.
Your account team will start by helping you determine all of the Akamai products and services you'll need to deliver your content and add them to your contract. This workflow includes at least these products:
- Ion. Akamai’s Ion solution helps streamline and secure the delivery of your website or app.
- NetStorage. We're using this as our origin to store your deliverable content—all of the assets for your website or app.
Which Ion version do you have?
You can have one of two versions of Ion on your contract. API operations use the codename values that Akamai established for these versions during development:
- Ion Premier.
- Ion Standard.
Make note of the codename for your version of Ion.
- Your account team will add a primary group to your contract so you can organize your objects. Objects are the things you'll create and use to deliver your content.
- They'll add an Admin role to your primary group that grants permission to all Akamai products and services on your contract.
- Finally, they'll set up a user that's been assigned this Admin role. It's associated with your email address and a password you choose. We'll call this your "primary admin" user.
A content provider (CP) code is what we use to track usage of Akamai services. Your account team will initially get you at least two of these codes for this workflow—one for use with Ion for your delivery configuration (property) and another for NetStorage as your origin server. Each CP code is comprised of two parts:
- An integer value. This is a 5-7 digit value that Akamai generates.
- A unique alphanumeric name. You pick this value.
You'll use these later in this onboarding process.
Before you can get going with any Akamai API, you need to set up authentication credentials for access. Here, we set up an "API client" for the primary admin user with these credentials for all of the APIs you’ll be using.
Access Control Center and log in using your primary admin account.
Select ☰ > ACCOUNT ADMIN > Identity & access.
Under Users and API Clients, click Create API client.
Click Quick to create an API client that's associated with the current account.
Click Show additional details and have a look at the APIs table. The credential values you create with this API client can be used to access the APIs for all of the products and services listed in this table. You'll need access to these APIs for this onboarding:
- Identity Management (IDM): User Administration. You can use this API to create and manage groups, roles, and users. The Access level needs to be ADMIN.
- Property Manager (PAPI). This is the tool used to set up your delivery product. The Access level needs to be READ-WRITE.
- CPS. This is the Certificate Provisioning System API. You'll use this to secure the connection between a requesting client and Akamai edge servers. The Access level needs to be READ-WRITE.
- NetStorage. The Access level needs to be READ-WRITE.
- Reporting API. This one is optional. You can use this to generate report data for your website or app. The Access level needs to be READ-WRITE.
Click Hide additional details once you're done verifying.
In the Credentials section, click Download. You'll get your credential values stored in the
You only get one chance to get your "client_secret"
client_secretvalue is only available a single time in this interface—right now when you're creating the credential. Make sure you Download the credential now to have a permanent, local record. You won't be able to come back to this interface to get it later.
Click Edit API Client to save the credential in a new API client.
Open the downloaded file with a text editor and add the value
[default]as a header above all text. Your finished file should look like this:
Save the file in your home directory using
.edgercas the full filename. The default home directory location for these operating systems is typically:
You're ready to start calling Akamai APIs!
You're ready to go to the next phase. You can use your primary admin user along with the API client you created to do everything covered in this onboarding workflow.
However, you can also use the Identity Management: User Administration API to do other things. Let's look at a couple of simple tasks you can perform to add more users.
Here, we'll clone your primary admin so another person in your organization can also be an administrator in your primary group.
You'll need the
uiUserName value for the user you want to clone.
Now, we'll create a new user. We'll clone the admin access from the primary admin, but then customize other settings for the new user.
Once this new user is ready, Akamai sends a confirmation email that includes a one-time password. The new user should go to https://control.akamai.com[https://control.akamai.com] and log in using this email address and the password to verify access. Once logged in, the new user can:
- Change their password from the one-time one.
- Set up their own authentication credentials in an API client.
Here, we'll set up a role that limits access to various products and services in your primary group. Then, we'll set up a user to use this role.
Each group on your contract has a unique identifier assigned to it. This includes the primary group that Akamai creates for you.
Each Akamai product or service has a unique role identifier assigned to it. You'll need the identifiers for each of the products you want to be included in the role.
With the role identifiers in hand, you can create the role.
Now you can create a new user and apply the role you just created.
See Log in with the new user, above.
The API operations here have been customized for these specific tasks. You can do more with them. Plus, there are other operations in the Identity Management: User Administration API. For example, you can create more groups to organize different objects and customize access to them via new roles and associated users.
Updated about 1 month ago