Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

The Get API Key API retrieves the API keys that were created in your account. 

You can use this API to find the key ID (id), which you will need for other API Key-related APIs.

Sample request

GET https://api.armor.com/users/2/keys?$orderby=name desc&$top=20&$skip=0&$filter=status%20eq%20enabled

Input 

The following table describes the different parts of this API call: 

API Call / URLMethod / Type

/users/2/keys?$orderby=name desc&$top=20&$skip=0&$filter=status%20eq%20enabled

GET

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionRequired or optionalTypeExample
(user) id

The ID of the user who created the API key.

You can use the Get User API to find the user ID.

RequiredInteger2



Sample return

StatusResponse
200
{
   "total": 3,
   "page": 1,
   "items": [
      {
         "id": "347443fc-035a-4b7f-b8fd-47773f08fa36",
         "name": "Test_Tde",
         "createdDate": "2018-06-06T11:29:34.803",
         "lastUsed": null,
         "keyStatus": "ENABLED"
      },
      {
         "id": "79427e43-0609-462b-93fe-8150aa4aeae4",
         "name": "test_add",
         "createdDate": "2018-06-06T16:36:13.93",
         "lastUsed": null,
         "keyStatus": "ENABLED"
      }
   ]
}