List available RBAC roles for an account

Return the available RBAC roles for an account. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
accountId
required
string <uuid>
Example: a18afd39-1182-4a78-8cd9-b410b9de2ea0
Responses
200

OK

4XX

Invalid Request

get/accounts/{accountId}/rbac-roles
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{
    "Authorization" = "Bearer $apiKey"
    "Content-Type" = "application/json"
}
$url = "https://console.automox.com/api/accounts/{accountId}/rbac-roles"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "data": [
    • {
      • "slug": "zone-admin",
      • "type": "zone",
      • "name": "Zone Administrator",
      • "description": "Provides full administrative rights to a specific zone."
      },
    • {
      • "slug": "read-only",
      • "type": "zone",
      • "name": "Read Only",
      • "description": "Provides full read rights to a specific zone."
      },
    • {
      • "slug": "billing-admin",
      • "type": "zone",
      • "name": "Billing Administrator",
      • "description": "Provides full read rights in addition to the ability to view/edit billing information."
      },
    • {
      • "slug": "zone-operator",
      • "type": "zone",
      • "name": "Zone Operator",
      • "description": "Provides ability to manage policies, endpoints, and server groups."
      },
    • {
      • "slug": "patch-operator",
      • "type": "zone",
      • "name": "Patch Operator",
      • "description": "Provides the ability to execute patch, software, and worklet policies, as well as create and edit patch policies. This role cannot create or edit worklet or required software policies."
      },
    • {
      • "slug": "global-admin",
      • "type": "account",
      • "name": "Global Administrator",
      • "description": "Provides full administrative rights to the entire Automox Account."
      },
    • {
      • "slug": "no-global-access",
      • "type": "account",
      • "name": "No Global Access",
      • "description": "Provides zone level permissions only with no access to the Global View."
      }
    ],
  • "metadata": {
    • "total_count": 6,
    • "total_pages": 1,
    • "current_page": 0,
    • "limit": 500,
    • "links": [ ]
    }
}