List all api key objects for organization

PREREQUISITES: You must have Full Administrator privileges! This endpoint allows you to list all key objects for an organization. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
id
required
integer <int64>

The ID of the organization to list keys for.

Example: 123456
query Parameters
limit
integer [ 1 .. 500 ]
Default: 500

A limit on the number of results to be returned, between 1 and 500, with a default of 500. Use with page parameter. See About Automox API - Pagination

Example: limit=500
page
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0. See About Automox API - Pagination

Example: page=0
Responses
200

Successful Operation

4XX

Invalid Request

default

Invalid Request

get/orgs/{id}/api_keys
Request samples
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/orgs/{0000}/api_keys"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "summary": "API keys list example",
  • "description": "Example response for retrieving API keys with user information and pagination details",
  • "value": {
    • "results": [
      • {
        • "id": 250624,
        • "name": "Jane",
        • "is_enabled": true,
        • "expires_at": null,
        • "created_at": "2023-04-20T15:46:56+0000",
        • "user": {
          • "id": 250624,
          • "firstname": "Jane",
          • "lastname": "Doe",
          • "email": "jane.doe@example.com"
          }
        }
      ],
    • "size": 1
    }
}