API Key Information

If a user has an API Key its information can be viewed.
Authentication required, please visit this page for Authentication How To.

Parameters

SecretKey - API Key from Administration > Users > API Keys
It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

200
401
403

Example return:

{
  "expireDate": "2022-11-17T15:10:28",
  "uuid": "54fa90f6-40ff-4f14-bfc5-5b1c0e89fc90",
  "email": "delete@me.com",
  "isSuperUser": false,
  "tenants": [
    {
      "uuid": "54fa90f6-40ff-4f14-bfc5-5b1c0e89fc90",
      "userId": 13735,
      "tenantId": 2,
      "tenantName": "ContactCenter",
      "tenancyName": "ContactCenter",
      "firstName": "Imma",
      "lastName": "Getdeleted",
      "phoneNumber": null,
      "tenantGuid": "3a0cc40e-b095-4642-ab23-5e3ed4be1b02",
      "roles": [],
      "groups": [],
      "queues": [],
      "isAdmin": false
    }
  ],
  "currentTenant": {
    "uuid": "54fa90f6-40ff-4f14-bfc5-5b1c0e89fc90",
    "userId": 13735,
    "tenantId": 2,
    "tenantName": "ContactCenter",
    "tenancyName": "ContactCenter",
    "firstName": "Imma",
    "lastName": "Getdeleted",
    "phoneNumber": null,
    "tenantGuid": "3a0cc40e-b095-4642-ab23-5e3ed4be1b02",
    "roles": [],
    "groups": [],
    "queues": [],
    "isAdmin": false
  },
  "isExpired": false,
  "info": "Authorization accepted",
  "userName": "delete@me.com",
  "currentTenantId": 2,
  "mcxPermissionType": 1
}