Update Portal Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

The request schema to modify an portal audit log webhook.

enabledboolean

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

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

include_principal_nameboolean

Whether to include the principal name in the audit log entries sent to the webhook.

Default:false

Example:true

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.

include_principal_nameboolean

Whether to include the principal name in the audit log entries sent to the webhook.

Default:false

Example:true

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

Body

{ "enabled": false }
 
application/json

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.

include_principal_nameboolean

Whether to include the principal name in the audit log entries sent to the webhook.

Default:false

Example:true

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

CreatePortalIdpTeamGroupMappingRequest

object
team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The IdP group name.

Example:API Engineers

Example

PortalIdpTeamGroupMapping

object
idstring(uuid)requiredread-only

The mapping ID.

Example:a1b2c3d4-e5f6-4a8b-9c0d-1e2f3a4b5c6d

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The IdP group name.

Example:API Engineers

created_atstring(date-time)requiredread-only

Creation timestamp.

Example:2024-01-15T10:30:00Z

updated_atstring(date-time)requiredread-only

Last update timestamp.

Example:2024-01-15T10:30:00Z

Example

PortalIdpTeamGroupMappingCollectionResponse

object
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required
Show Child Parameters
Example