Skip to main content
API docs by Redocly

Signicat Audit API (v1)

Download OpenAPI specification:Download

Introduction

The Signicat Audit API allows you to query, view and filter audit log events.

This API is part of our management APIs, which allow you to programmatically manage configurations that are typically handled in the Signicat Dashboard.

This REST API uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

Query

Retrieve audit log item

Retrieves a single audit log item based on a cursor

path Parameters
cursor
required
string

Responses

Response samples

Content type
{
  • "cursor": "string",
  • "accountId": "string",
  • "organizationId": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "serviceName": "string",
  • "message": "string",
  • "sandbox": true,
  • "userId": "string",
  • "messageId": "string",
  • "referenceId": "string",
  • "ipAddress": "string",
  • "traceId": "string",
  • "eventType": "string",
  • "clientId": "string",
  • "jwtId": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "data": null,
  • "indexedData": {
    },
  • "mayHaveMoreData": true
}

Fetch metadata

Allows the user to retrieve metadata useful for building queries

Responses

Response samples

Content type
{
  • "extended": true,
  • "targets": [
    ]
}

Fetch properties for event

Allows the user to retrieve metadata useful for building queries

query Parameters
target
required
string
serviceName
required
string
eventType
string

Responses

Response samples

Content type
{
  • "properties": [
    ]
}

Query

Usage:

  • cursor query parameter must not be set manually - use next URL for pagination
  • limit can not be higher than 1000, is 1000 by default
  • Default value of to is now
  • Default value of from is 30 days before to
  • Results are sorted by most recent to least recent
  • As long as the next response property is set there may be more results available, even if the current response returned 0 results
query Parameters
cursor
string
limit
integer <int32>
Default: 1000
Request Body schema: application/json
Array of objects or null (QueryCondition)

Query for audit logs that match all the given conditions

from
string or null <date-time>

Earliest possible audit log to retrieve

to
string or null <date-time>

Latest possible audit log to retrieve (not inclusive)

Responses

Request samples

Content type
application/json
{
  • "and": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "data": [
    ],
  • "next": "string",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z"
}