Get Audit Log Webhook

Returns configuration for the audit log webhook.

get

Response

application/json

Get response for audit log webhook

endpointstring

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

enabledboolean

Indicates whether audit data should be sent to the webhook.

Example:true

log_formatstring

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.

Default:false

Example:false

updated_atstring(date-time)read-only

Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.

get/audit-log-webhook
 
application/json

Get Audit Log Webhook Status

Returns status of the audit log webhook.

get

Response

application/json

Get response for audit log webhook status

webhook_statusstring

Current status of a webhook. active indicates the webhook is sending or ready to send requests.
inactive indicates the webhook has been turned off due to failed attempts.

Allowed values:activeinactive

Example:active

webhook_enabledboolean

Configured status of a webhook. enabled indicates the client will accept requests.
disabled indicates the client will not accept requests.

Example:true

last_attempt_atstring(date-time)

The last time a request was made to the webhook, regardless of outcome.

Example:2023-03-21T09:29:14.52Z

last_response_codeinteger

The last response code received from the webhook.

Example:401

last_response_messagestring

The last message received from the webhook. Useful for debugging.

Example:Unauthenticated

get/audit-log-webhook/status
 
application/json

Get Audit Log JSON Web Keys

Returns the public keys used to sign audit log entries in order to verify the validity of audit log entries.

get

Response

200 application/json

Get response for the audit log JSON Web Keys

keysarray[object]

An individual JSON Web Key.

Example:{"kty":"OKP","alg":"EdDSA","kid":"3f60bc4376c937154f3c004ebd180433ac0d03e6","crv":"Ed25519","x":"XWxGtApfcqmKI7p0OKnF5JSEWMVoLsytFXLEP7xZ_l8"}

Show Child Parameters
get/audit-log-webhook/jwks.json
 
200 application/json

Get Audit Log Destinations

Returns configuration for the audit log destinations.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter destinations returned in the response.

Show Child Parameters

Response

application/json

Response for audit log destinations

ListAuditLogDestinations

dataarray[object]required

Audit Log Destination Schema

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/audit-log-destinations
 
application/json

Create Audit Log Destination

Creates a configuration for the audit log destination.

post

Body

application/json

The request schema to create an audit log destination.

namestringrequired

The name of the audit log destination.

Example:My Destination

endpointstringrequired

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

authorizationstringrequired

The value to include in the Authorization header when sending audit logs to the webhook.

Example:Bearer sometoken

log_formatstringrequired

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.
We strongly recommend not setting this to ‘true’ as you are subject to man-in-the-middle and other attacks.
This option should be considered only for self-signed SSL certificates used in a non-production environment.

Default:false

Example:false

Response

application/json

Audit log destination response

AuditLogDestination

Audit Log Destination Schema

idstring(uuid)

The unique ID of the audit log destination.

namestring

The name of the audit log destination.

endpointstring

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

log_formatstring

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.

Default:false

Example:false

created_atstring(date-time)read-only

Timestamp when this webhook was created.

updated_atstring(date-time)read-only

Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.

post/audit-log-destinations

Body

{ "id": "07ec3858-066b-4629-bdc5-d4aa893b424d", "name": "My Destination", "endpoint": "https://example.com/audit-log", "authorization": "Bearer token", "log_format": "cef", "skip_ssl_verification": false }
 
application/json