Get an API client
GET https://{{host}}/identity-management/v3/api-clients/:clientId
This operation provides details about an API client.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
actions | string | (Optional) Includes actions you can perform on the object, false by default. | |
groupAccess | string | (Optional) Includes the API client's group access, false by default. | |
apiAccess | string | (Optional) Lists only the APIs the user can access, false by default. | |
credentials | string | (Optional) Includes API user's credentials, false by default. | |
ipAcl | string | (Optional) Includes the API client's IP list restriction, false by default. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"accessToken":"akaa-whlw7vibvujyoowg-rrp2q4cj362hke5t","actions":{"delete":false,"deactivateAll":false,"edit":true,"editApis":false,"editAuth":false,"editGroups":false,"editIpAcl":false,"editSwitchAccount":false,"lock":false,"transfer":true,"unlock":false},"activeCredentialCount":1,"allowAccountSwitch":false,"apiAccess":{"allAccessibleApis":true,"apis":[{"accessLevel":"READ-WRITE","apiId":5101,"apiName":"Reporting API","description":"Luna Reporting API","documentationUrl":"https://developer.akamai.com/api/luna/reporting-api/overview.html","endPoint":"/reporting-api"}]},"authorizedUsers":["jsmith"],"baseURL":"https://akaa-csrfyd3yzysqybe3-3dwjebsqo6ecu63m.luna-dev.akamaiapis.net","canAutoCreateCredential":false,"clientDescription":"Provides access to the reporting data.","clientId":"4f3cxdie6adyalyg","clientName":"report_data","clientType":"CLIENT","createdBy":"alfulani","createdDate":"2022-05-09T10:43:49.000Z","credentials":[{"actions":{"delete":false,"activate":false,"deactivate":false,"editDescription":false,"editExpiration":false},"clientToken":"0000-0000000000000000-000000000000000","createdOn":"2022-05-09T10:43:50.000Z","credentialId":16850686,"description":"","expiresOn":"2024-05-09T10:43:50.000Z","status":"ACTIVE"}],"groupAccess":{"cloneAuthorizedUserGroups":true,"groups":[{"groupId":54321,"groupName":"Internet Company","isBlocked":false,"roleDescription":"Admin Role plus Authz Case Management Read Role","roleId":142838,"roleName":"Admin plus Authz Case Management Read","subGroups":[{"groupId":12345,"groupName":"Cloud Access Manager","isBlocked":false,"parentGroupId":19717,"roleDescription":"Cloud Access Manager Admin","roleId":114776,"roleName":"Cloud Access Manager Admin","subGroups":[]}]}]},"ipAcl":{"cidr":["2001:db8::1","2001:db8::2"],"enable":true},"isLocked":false,"notificationEmails":["alfulani@example.com"],"purgeOptions":{"canPurgeByCacheTag":false,"canPurgeByCpcode":false,"cpcodeAccess":{"allCurrentAndNewCpcodes":true,"cpcodes":[]}}}