Retrieve all Audit Log Entries

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/audit

GET

/v2/org/:org/nico/audit

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/audit \
     -H "Authorization: Bearer <token>" \
     -d pageSize=20

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

Get all Audit Log entries

User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired

Name of the Org

Query parameters

failedOnlybooleanOptional

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

pageNumberintegerOptional1-21474836

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Allowed values:

Response

idstringOptionalRead-onlyformat: "uuid"

Unique identifier

endpointstringOptional

API endpoint

queryParamsmap from strings to lists of stringsOptional

Query parameters from the request URL, keyed by parameter name. Each value contains all values supplied for that parameter.

methodstringOptional

HTTP method

bodyobjectOptional

Audited request body. JSON object bodies retain their properties directly after sensitive fields are recursively obfuscated. Valid non-object JSON is stored in value. Malformed JSON is represented by jsonParseFailed: true without retaining the raw request content.

statusCodeintegerOptional

HTTP response status code

statusMessagestringOptional

HTTP response status message

clientIPstringOptional

Client IP address

userIDstring or nullOptionalformat: "uuid"

User ID that executed the API call

userobjectOptional

User that executed the API call

orgNamestringOptional

Organization name

extraDataobjectOptional

Extra data in JSON format

timestampdatetimeOptional

API execution time

durationMslongOptional

API execution duration in milliseconds

apiVersionstringOptional

API version

Errors

403

Forbidden Error