Retrieves a user by user ID

Retrieves a user by user ID See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
userId
required
integer <int64>

The User ID of the user to retrieve

query Parameters
o
required
integer <int64>

The Organization whose users you wish to list. The organization will be assumed based on the API key, if not specified.

Responses
200

Successful Operation

4XX

Invalid Request

default

Invalid Request

get/users/{userId}
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{
    "Authorization" = "Bearer $apiKey"
}
$url = 'https://console.automox.com/api/users/999999?o=0000'
Invoke-WebRequest -Method Get -Uri $url -Headers $headers
Response samples
application/json
{
  • "summary": "User object example",
  • "description": "Example of a complete user object with profile information, organization memberships, RBAC roles, and account details",
  • "value": {
    • "id": 250624,
    • "uuid": "a8c04f5e-0e35-4521-ac64-be8b0f27be4d",
    • "firstname": "Jane",
    • "lastname": "Doe",
    • "email": "jane.doe@example.com",
    • "features": {
      • "mo": false
      },
    • "prefs": [ ],
    • "orgs": [
      • {
        • "id": 654321,
        • "zone_id": "7183672f-39cc-4693-af82-4a3ae84ca763",
        • "name": "Test Org",
        • "trial_end_time": null,
        • "create_time": "2023-03-07T05:11:17+0000",
        • "plan": "tier3",
        • "parent_id": null,
        • "access_key": "73b827c3-1c12-460d-8655-f05e99e39f89",
        • "metadata": { }
        },
      • {
        • "id": 123456,
        • "zone_id": "c70e7781-c899-4770-9d98-032f9bf73d88",
        • "name": "Another Test Org",
        • "trial_end_time": null,
        • "create_time": "2024-04-03T16:19:36+0000",
        • "plan": "tier3",
        • "parent_id": 654321,
        • "access_key": "49ee1c85-2670-429b-8ad5-1f2e20233d33",
        • "metadata": { }
        }
      ],
    • "tags": [
      • "foo-test",
      • "Linux",
      • "VM",
      • "Windows"
      ],
    • "metadata": {
      • "overviewReportRun": true,
      • "prepatchReportRun": true
      },
    • "saml_enabled": false,
    • "sso_enabled": false,
    • "rbac_roles": [
      • {
        • "id": 1,
        • "name": "Zone Administrator",
        • "description": "Provides full administrative rights to a specific zone.",
        • "organization_id": 654321
        },
      • {
        • "id": 1,
        • "name": "Zone Administrator",
        • "description": "Provides full administrative rights to a specific zone.",
        • "organization_id": 987654
        }
      ],
    • "intercom_hmac": "",
    • "tfa_type": "email",
    • "server_groups": [ ],
    • "account_id": "d7a6d9ba-0097-49af-992a-126b57001c7f",
    • "account_name": "Test Account",
    • "account_rbac_roles": "global-admin",
    • "account_completed_qsg": true,
    • "account_created_at": "2023-03-07T17:11:17+0000"
    }
}