Retrieves an API key object by ID

Note: The response does not contain the encrypted portion of the key. See Decrypt User API Key

SecuritybearerAuth
Request
path Parameters
userId
required
integer

The ID of the user to view keys for.

id
required
integer

The ID of the API key object to retrieve

query Parameters
o
required
integer

The target organization

Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

get/users/{userId}/api_keys/{id}
Request samples
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = 'https://console.automox.com/api/users/{98765}/api_keys/999999?o=0000'
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers -ContentType "application/json").Content
Response samples
application/json
{
  • "id": 0,
  • "name": "string",
  • "is_enabled": true,
  • "expires_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "user": {
    • "id": 0,
    • "firstname": "string",
    • "lastname": "string",
    • "email": "user@example.com"
    }
}