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\>

Try it

/v1/mgmt/audit/search

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

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>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/audit/search" \
  -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"
  ]
}'

{
  "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"
    }
  ]
}

Was this helpful?