Sign in
Audit

Retrieve all Audit Log Entries

Get all Audit Log entries

User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

get/v2/org/{org}/nico/audit

Query parameters

failedOnlyboolean

Return only audit log entries that have failed status code (>= 400)

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'TIMESTAMP_ASC' | 'TIMESTAMP_DESC'

Ordering for pagination query

Response

OK

idstring uuid

Unique identifier

endpointstring

API endpoint

queryParamsstring

Query parameters

methodstring

HTTP method

bodystring

HTTP body in JSON format

statusCodeinteger

HTTP response status code

statusMessagestring

HTTP response status message

clientIPstring

Client IP address

userIDstring uuid nullable

User ID that executed the API call

orgNamestring

Organization name

extraDataobject

Extra data in JSON format

timestampstring date-time

API execution time

durationMsinteger

API execution duration in milliseconds

apiVersionstring

API version

Example response

[
  {
    "id": "e313b3ca-c47a-4ec1-a79b-a147fad51a50",
    "endpoint": "/v2/org/test-org-1/nico/ep",
    "queryParams": "{\"test\":[\"1234\"]}",
    "method": "POST",
    "body": "{\"key1\":\"value1\"}",
    "statusCode": 200,
    "clientIP": "12.123.43.112",
    "userID": "5d9fe319-14d4-40e3-8e5a-7d79e680d55b",
    "user": {
      "id": "5d9fe319-14d4-40e3-8e5a-7d79e680d55b",
      "firstName": "John",
      "lastName": "Doe",
      "email": "jdoe@test.com"
    },
    "orgName": "test-org-1",
    "timestamp": "2024-12-04T21:06:33.849293-08:00",
    "durationMs": 250,
    "apiVersion": "0.1.91"
  }
]

Changes

Changed in 5 of the 90 revisions of this API.81

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

  • 15aa8e481b852See the full diff
    • ▲

      the items/body response's property type/format changed from object/ to string/ for status 200

      response-property-type-changed

    • ▲

      the items/queryParams response's property type/format changed from object/ to string/ for status 200

      response-property-type-changed

  • b078e63260c12See the full diff
    • ▲

      the items/body response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the items/queryParams response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

  • ffa0635230582See the full diff
    • ▲

      the items/body response's property type/format changed from object/ to string/ for status 200

      response-property-type-changed

    • ▲

      the items/queryParams response's property type/format changed from object/ to string/ for status 200

      response-property-type-changed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f20872e0979a2See the full diff
    • ▲

      the items/body response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the items/queryParams response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed