Search Audit | API Reference | Descope Documentation

POST

/v1/mgmt/audit/search

Search the audit log, using a valid management key.

This API endpoint allows you to search the audit log utilizing various search parameters and returns the results in JSON format.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Authorization

`Authorization`
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

`from`string

`to`string

`userIds`array<string>

`actions`array<string>

`devices`array<string>

`methods`array<string>

`geos`array<string>

`remoteAddresses`array<string>

`externalIds`array<string>

`tenants`array<string>

`noTenants`boolean

`text`string

`excludedActions`array<string>

`actorIds`array<string>

`batchSize`integer

Format: "int32"

`page`integer

Format: "int32"

`searchFields`array<object>

Status code	Description
`200`	OK

curl -X POST "https://api.descope.com/v1/mgmt/audit/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "from": "string",
  "to": "string",
  "userIds": [
    "string"
  ],
  "actions": [
    "string"
  ],
  "devices": [
    "string"
  ],
  "methods": [
    "string"
  ],
  "geos": [
    "string"
  ],
  "remoteAddresses": [
    "string"
  ],
  "externalIds": [
    "string"
  ],
  "tenants": [
    "string"
  ],
  "noTenants": true,
  "text": "string",
  "excludedActions": [
    "string"
  ],
  "actorIds": [
    "string"
  ],
  "batchSize": 0,
  "page": 0,
  "searchFields": [
    {
      "field": "string",
      "valArr": [
        "string"
      ],
      "valStr": "string",
      "negative": true,
      "valType": "string"
    }
  ]
}'

{
  "audits": [
    {
      "ID": "string",
      "projectId": "string",
      "userId": "string",
      "action": "string",
      "occurred": "string",
      "device": "string",
      "method": "string",
      "geo": "string",
      "remoteAddress": "string",
      "externalIds": [
        "string"
      ],
      "tenants": [
        "string"
      ],
      "data": {},
      "type": "string",
      "actorId": "string"
    }
  ],
  "total": 0
}

Was this helpful?

Search the audit log, using a valid management key.

Endpoint Authentication

Try it

Authorization

AuthorizationRequiredBearer <token>

Request Body

fromstring

tostring

userIdsarray<string>

actionsarray<string>

devicesarray<string>

methodsarray<string>

geosarray<string>

remoteAddressesarray<string>

externalIdsarray<string>

tenantsarray<string>

noTenantsboolean

textstring

excludedActionsarray<string>

actorIdsarray<string>

batchSizeinteger

pageinteger

searchFieldsarray<object>

Object 1

Response

Typescript