Skip to content

List authentication audit events

Request

Returns a paginated list of authentication audit events for the organization, such as portal logins and API key usage.

The x-total-count response header contains the total number of records matching the query.

Requires audits::read:user permission.

Security
JWTAuthorizer
Query
sTimestring

Start time (ISO 8601) to query from

eTimestring

End time (ISO 8601) to query to

pageinteger

Page number (1-based)

Default:1
limitinteger, <= 200

Maximum number of results per page (max 200)

Default:50
sortstring

Sort field and direction, e.g. timestamp:desc

qstring

Free-text search query

ipsArray of strings

Filter by IP addresses

userIDsArray of strings

Filter by user IDs

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/audit/auth?sTime=string&eTime=string&page=1&limit=50&sort=string&q=string&ips=string&userIDs=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Headers
x-total-countinteger

Total number of records matching the query

Bodyapplication/json
Array [
uidstring

Unique identifier

orgstring

Organization ID

timestampstring

Timestamp of the event (ISO 8601)

Example:"2024-10-21T17:35:26Z"
ipstring

IP address of the client

Example:"44.44.44.43"
messagestring

Human-readable description of the authentication event

Example:"Portal login (Local Authentication)"
userIdstring

User who performed the authentication

Example:"admin@example.com"
]
Response
[
  {
    "uid": "string",
    "org": "string",
    "timestamp": "2024-10-21T17:35:26Z",
    "ip": "44.44.44.43",
    "message": "Portal login (Local Authentication)",
    "userId": "admin@example.com"
  }
]