Get Portal Audit Log Webhook

Returns configuration for the audit log webhook.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Portal audit log webhook response

enabledboolean

Indicates if the data should be sent to the configured audit log destination.

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

get/portals/{portalId}/audit-log-webhook
 
application/json

Delete Portal Audit Log Webhook

Removes configuration for the audit log webhook. The destination ID is set to empty, and the webhook enabled field is set to false

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}/audit-log-webhook
 

Get Portal Audit Log Webhook Status

Returns status of the audit log webhook.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Get response for portal 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/portals/{portalId}/audit-log-webhook/status
 
application/json

AuthStrategy

object
One Of
idstring(uuid)requiredread-only

The Application Auth Strategy ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

Default:name

Example:name

credential_typestringrequired

Allowed values:key_auth

key_namesarray[string]required
ttlobject

Default maximum Time-To-Live for keys created under this strategy.

Show Child Parameters
Example

PortalClaimMappings

object

Mappings from a portal developer atribute to an Identity Provider claim.

namestring

Default:name

Example:name

emailstring

Default:email

Example:email

groupsstring

Default:groups

Example:custom-group-claim

Example