Organizations

Enable or disable audit logging for an organization

Enable or disable audit logging for the organization. Enabling provisions a warehouse user and an audit log connection. Disabling deletes an existing audit log storage integration along with any scheduled exports attached to them, archives the connection, and deletes the warehouse user.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • To read or update this setting for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.
patch/v2/organizations/settings/auditLogging

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

enabledboolean required

Whether audit logging should be enabled for the organization.

Response

The audit logging status after accepting the update request.

status'enabled' | 'enable_in_progress' | 'disabled' | 'disable_in_progress' required

Current state of audit logging for the organization. enable_in_progress and disable_in_progress mean a background task is still running.

Changes

No recorded changes to this operation across all 1 revision of this API.