GetKeys

POST

https://api.voximplant.com/platform_api/GetKeys

POST

/platform_api/GetKeys

curl -X POST https://api.voximplant.com/platform_api/GetKeys \
     -H "Authorization: Bearer <token>"

200Example 1

{
  "result": [
    {
      "key_id": "8fef2dfc-500d-4923-847d-28062d6dad16",
      "roles": [
        {
          "role_name": "Accountant",
          "role_id": 7
        },
        {
          "role_name": "Support",
          "role_id": 3
        },
        {
          "role_name": "TestRole",
          "role_id": 14
        }
      ],
      "description": null
    },
    {
      "key_id": "fae19af6-9960-4091-a7fe-a8b88c15aaec",
      "roles": [],
      "description": null,
      "subuser": {
        "subuser_name": "tt",
        "subuser_id": 276
      }
    },
    {
      "key_id": "6fb5e821-3760-4373-9610-f0694fa326e8",
      "roles": [],
      "description": null
    }
  ],
  "total count": 3,
  "count": 3
}

Gets key info of the specified account.

Example request: Get keys info of the specified account.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

key_idstringOptional

The key's ID

with_rolesbooleanOptional

Whether to show roles for the key

offsetintegerOptional

The first N records are skipped in the output

countintegerOptional

The max returning record count

Response

Successful response

resultlist of objectsOptional

total countintegerOptional

countintegerOptional