Skip to main content
GET

Overview

The Roles endpoint provides access to role definitions, permissions, and assigned users within the ThreatAware platform.

Parameters

number
default:"0"
Set the start position of the data returned by the API
number
default:"0"
Limit each request by the provided number. Leave blank or as 0 to return all data available

Authentication

string
required
Your ThreatAware API key
string
default:"application/json"
Response format

Response

number
The starting position of this result set
number
The number of results returned
number
Total number of roles
boolean
Whether the request was successful
number
HTTP status code
string
Status message
array

Common Roles

Full platform access
  • All permissions enabled
  • User, role, and team management
  • Integration and API key management
  • SSO configuration
Security operations focus
  • View all devices and users
  • Manage alerts and actions
  • Export reports
  • Limited administrative access
Read-only access
  • View devices, users, and alerts
  • Generate reports
  • No modification permissions

Use Cases

Access Review

Export role assignments for periodic access reviews

Compliance Reporting

Document role-based access control (RBAC) for audits

Permission Auditing

Track which users have administrative permissions

Onboarding Automation

Automate role assignment based on department or job title

Get Users

View user accounts and their assigned roles

Get Teams

View team structure and members