List API clients
GET https://{{host}}/identity-management/v3/api-clients
This operation lists API clients an administrator can manage on the current account or other managed accounts using the accountSwitchKey
parameter.
Body
PARAM
Key | Datatype | Required | Description |
actions
|
string | (Optional) Includes actions you can perform on the object, `false` by default. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
[
{
"accessToken": "akaa-ly55myu4fbtajqck-o7oubkbiytbjxywe",
"actions": {
"delete": false,
"deactivateAll": false,
"edit": true,
"lock": false,
"transfer": true,
"unlock": false
},
"activeCredentialCount": 1,
"allowAccountSwitch": false,
"authorizedUsers": [
"jdoe"
],
"canAutoCreateCredential": false,
"clientDescription": "Provides access to the reporting data.",
"clientId": "xfz2n5d43mogkdim",
"clientName": "report_data",
"clientType": "CLIENT",
"createdBy": "mrossi",
"createdDate": "2022-05-13T20:04:35.000Z",
"isLocked": false,
"notificationEmails": [
"jdoe@example.com"
],
"serviceConsumerToken": "akaa-lb77cyyf3guivns3-sxmd4sxxxxxxxxxx"
},
{
"accessToken": "akaa-whlw7vibvujyoowg-rrp2q4xxxxxxxxxx",
"actions": {
"delete": false,
"deactivateAll": false,
"edit": true,
"lock": false,
"transfer": true,
"unlock": false
},
"activeCredentialCount": 1,
"allowAccountSwitch": false,
"authorizedUsers": [
"jsmith"
],
"canAutoCreateCredential": false,
"clientDescription": "Provides all offload estimates.",
"clientId": "4f3cxdie6adyalyg",
"clientName": "offload_est",
"clientType": "CLIENT",
"createdBy": "jsmith",
"createdDate": "2022-05-09T10:43:49.000Z",
"isLocked": false,
"notificationEmails": [
&q Curl curl -X GET 'https://host/identity-management/v3/api-clients?actions=&accountSwitchKey=' -H 'Accept: application/json' ENDPOINTS |