Skip to main content
GET

Overview

The Portal Users endpoint provides access to user accounts that have been created within the ThreatAware platform itself (not to be confused with the /users endpoint which returns user data from integrated directory services).
Difference from /users endpoint:
  • /users - Returns user data from Active Directory, Azure AD, etc. (directory services)
  • /settings/usermanagement/users - Returns ThreatAware portal user accounts

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 portal users
boolean
Whether the request was successful
number
HTTP status code
string
Status message
array

Use Cases

User Access Auditing

Track who has access to the ThreatAware portal and their permissions

MFA Compliance

Identify portal users without MFA enabled

Team Membership

Export user-to-team mappings for access reviews

SSO Adoption

Monitor SSO enablement across portal users

Get Roles

Retrieve role definitions and permissions

Get Teams

Retrieve team definitions and members