Create an API client
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
Request Body
{"allowAccountSwitch"=>false, "apiAccess"=>{"allAccessibleApis"=>false, "apis"=>[{"accessLevel"=>"READ-ONLY", "apiId"=>5000, "apiName"=>"Reporting API", "description"=>"Luna Reporting API", "documentationUrl"=>"https://developer.akamai.com/api/luna/reporting-api/overview.html", "endPoint"=>"/reporting-api"}]}, "authorizedUsers"=>["jsmith"], "canAutoCreateCredential"=>false, "clientDescription"=>"Provides access to the reporting data.", "clientName"=>"report_data", "clientType"=>"CLIENT", "createCredential"=>true, "groupAccess"=>{"cloneAuthorizedUserGroups"=>false, "groups"=>[{"groupId"=>32145, "groupName"=>"Internet Company", "isBlocked"=>false, "roleDescription"=>"Sales role", "roleId"=>1, "roleName"=>"Sales role", "subGroups"=>[{"groupId"=>32145, "groupName"=>"Digital Company", "isBlocked"=>false, "parentGroupId"=>18385, "roleDescription"=>"Sales role", "roleId"=>2, "roleName"=>"Sales"}]}]}, "ipAcl"=>{"cidr"=>["192.0.2.239", "192.0.2.20/24"], "enable"=>true}, "notificationEmails"=>["mrossi@example.com", "jsmith@example.com"], "purgeOptions"=>{"canPurgeByCacheTag"=>false, "canPurgeByCpcode"=>true, "cpcodeAccess"=>{"allCurrentAndNewCpcodes"=>false, "cpcodes"=>[7563521, 13243546]}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"accessToken":"akaa-eol24zwha6c2huw6-3at564pdmaggqrro","actions":{"delete":true,"deactivateAll":false,"edit":true,"editApis":true,"editAuth":true,"editGroups":true,"editIpAcl":true,"editSwitchAccount":false,"lock":true,"transfer":true,"unlock":false},"activeCredentialCount":0,"allowAccountSwitch":false,"apiAccess":{"allAccessibleApis":true,"apis":[{"accessLevel":"READ-WRITE","apiId":5101,"apiName":"Reporting API","description":"Control Center reporting API","documentationUrl":"https://developer.akamai.com/api/luna/reporting-api/overview.html","endPoint":"/reporting-api"}]},"authorizedUsers":["jsmith"],"baseURL":"https://akaa-g3bclnoojfn7jvua-ic3mtmz7dwkot4jw.luna-dev.akamaiapis.net","canAutoCreateCredential":false,"clientDescription":"Used to create users across partner accounts.","clientId":"2cdgugz2tjbtowmy","clientName":"create_new_users","clientType":"CLIENT","createdBy":"adevi","createdDate":"2022-05-23T19:56:27.000Z","credentials":[{"actions":{"delete":true,"activate":true,"deactivate":false,"editDescription":true,"editExpiration":true},"clientSecret":"11111111111111111111111111111111111111111111","clientToken":"0000-0000000000000000-000000000000000","createdOn":"2022-08-25T17:35:07.000Z","credentialId":16852304,"description":"","expiresOn":"2024-08-25T17:35:07.000Z","status":"INACTIVE"}],"groupAccess":{"cloneAuthorizedUserGroups":true,"groups":[{"groupId":32145,"groupName":"Main Street Corporation","isBlocked":false,"roleDescription":"Sales role","roleId":1,"roleName":"Sales role","subGroups":[{"groupId":32145,"groupName":"Cloud Access Manager","isBlocked":false,"parentGroupId":19717,"roleDescription":"Cloud Access Manager Admin","roleId":114776,"roleName":"Cloud Access Manager Admin","subGroups":[]}]}]},"isLocked":false,"notificationEmails":["jsmith@example.com"],"purgeOptions":{"canPurgeByCacheTag":false,"canPurgeByCpcode":false,"cpcodeAccess":{"allCurrentAndNewCpcodes":true,"cpcodes":[]}}}