Update your API client

PUT https://{{host}}/identity-management/v3/api-clients/self

This operation updates your API client.

Request Params

KeyDatatypeRequiredDescription
accountSwitchKeystring(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"=>109230, "apiName"=>"Event Center", "description"=>"Event Center", "documentationUrl"=>"https://developer.akamai.com/api/luna/events/overview.html", "endPoint"=>"/events"}, {"accessLevel"=>"READ-ONLY", "apiId"=>3515, "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", "groupAccess"=>{"cloneAuthorizedUserGroups"=>false, "groups"=>[{"groupId"=>54321, "groupName"=>"Main Street Corporation", "isBlocked"=>false, "roleDescription"=>"Please add a description", "roleId"=>73695, "roleName"=>"Custom role # 73695", "subGroups"=>[{"groupId"=>54321, "groupName"=>"Internet Company", "isBlocked"=>false, "parentGroupId"=>19760, "roleId"=>nil, "roleName"=>nil, "subGroups"=>[{"groupId"=>12345, "groupName"=>"Digital Company", "isBlocked"=>false, "parentGroupId"=>44999, "roleId"=>nil, "roleName"=>nil}]}]}]}, "notificationEmails"=>["jsmith@example.com"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"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-ONLY","apiId":164,"apiName":"Media Reports","description":"Media Reports APIs","documentationUrl":"https://developer.akamai.com/api/luna/media-reports/overview.html","endPoint":"/media-reports"},{"accessLevel":"READ-WRITE","apiId":5101,"apiName":"Reporting API","description":"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":"Provides access to the reporting data.","clientId":"2cdgugz2tjbtowmy","clientName":"report_data","clientType":"CLIENT","createdBy":"jperez","createdDate":"2022-05-23T19:56:27.000Z","groupAccess":{"cloneAuthorizedUserGroups":true,"groups":[{"groupId":12345,"groupName":"Main Street Corporation","isBlocked":false,"roleDescription":"CPCode RolePermissions Automation","roleId":114492,"roleName":"CP Code Automation Role","subGroups":[]},{"groupId":54321,"groupName":"High Street Company","isBlocked":false,"roleDescription":"Admin Role plus Authz Case Management Read Role","roleId":142838,"roleName":"Admin plus Authz Case Management Read","subGroups":[{"groupId":54321,"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":[]}}}