cloudflare/src/resources/security-center/insights/audit-logs.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../core/resource';
import { CloudflareError } from '../../../core/error';
import { CursorPagination, type CursorPaginationParams, PagePromise } from '../../../core/pagination';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseAuditLogs extends APIResource {
  static override readonly _key: readonly ['securityCenter', 'insights', 'auditLogs'] = Object.freeze([
    'securityCenter',
    'insights',
    'auditLogs',
  ] as const);

  /**
   * Lists audit log entries for all Security Center insights in the account or zone,
   * showing changes to insight status and classification.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const auditLogListResponse of client.securityCenter.insights.auditLogs.list(
   *   { account_id: 'account_id' },
   * )) {
   *   // ...
   * }
   * ```
   */
  list(
    params: AuditLogListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<AuditLogListResponsesCursorPagination, AuditLogListResponse> {
    const { account_id, zone_id, ...query } = params ?? {};
    if (!account_id && !zone_id) {
      throw new CloudflareError('You must provide either account_id or zone_id.');
    }
    if (account_id && zone_id) {
      throw new CloudflareError('You cannot provide both account_id and zone_id.');
    }
    const { accountOrZone, accountOrZoneId } =
      account_id ?
        {
          accountOrZone: 'accounts',
          accountOrZoneId: account_id,
        }
      : {
          accountOrZone: 'zones',
          accountOrZoneId: zone_id,
        };
    return this._client.getAPIList(
      path`/${accountOrZone}/${accountOrZoneId}/security-center/insights/audit-log`,
      CursorPagination<AuditLogListResponse>,
      { query, ...options },
    );
  }

  /**
   * Lists audit log entries for a specific Security Center insight, showing changes
   * to its status and classification over time.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const auditLogListByInsightResponse of client.securityCenter.insights.auditLogs.listByInsight(
   *   'issue_id',
   *   { account_id: 'account_id' },
   * )) {
   *   // ...
   * }
   * ```
   */
  listByInsight(
    issueID: string,
    params: AuditLogListByInsightParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<AuditLogListByInsightResponsesCursorPagination, AuditLogListByInsightResponse> {
    const { account_id, zone_id, ...query } = params ?? {};
    if (!account_id && !zone_id) {
      throw new CloudflareError('You must provide either account_id or zone_id.');
    }
    if (account_id && zone_id) {
      throw new CloudflareError('You cannot provide both account_id and zone_id.');
    }
    const { accountOrZone, accountOrZoneId } =
      account_id ?
        {
          accountOrZone: 'accounts',
          accountOrZoneId: account_id,
        }
      : {
          accountOrZone: 'zones',
          accountOrZoneId: zone_id,
        };
    return this._client.getAPIList(
      path`/${accountOrZone}/${accountOrZoneId}/security-center/insights/${issueID}/audit-log`,
      CursorPagination<AuditLogListByInsightResponse>,
      { query, ...options },
    );
  }
}
export class AuditLogs extends BaseAuditLogs {}

export type AuditLogListResponsesCursorPagination = CursorPagination<AuditLogListResponse>;

export type AuditLogListByInsightResponsesCursorPagination = CursorPagination<AuditLogListByInsightResponse>;

export interface AuditLogListResponse {
  /**
   * UUIDv7 identifier for the audit log entry, time-ordered.
   */
  id?: string;

  /**
   * The timestamp when the change occurred.
   */
  changed_at?: string;

  /**
   * The actor that made the change. 'system' for automated changes, or a user
   * identifier.
   */
  changed_by?: string;

  /**
   * The value of the field after the change. Null if the field was cleared.
   */
  current_value?: string | null;

  /**
   * The field that was changed.
   */
  field_changed?: 'status' | 'user_classification';

  /**
   * The ID of the insight this audit log entry relates to.
   */
  issue_id?: string;

  /**
   * The value of the field before the change. Null if the field was not previously
   * set.
   */
  previous_value?: string | null;

  /**
   * Optional rationale provided for the change.
   */
  rationale?: string | null;

  /**
   * The zone ID associated with the insight. Only present for zone-level insights.
   */
  zone_id?: number;
}

export interface AuditLogListByInsightResponse {
  /**
   * UUIDv7 identifier for the audit log entry, time-ordered.
   */
  id?: string;

  /**
   * The timestamp when the change occurred.
   */
  changed_at?: string;

  /**
   * The actor that made the change. 'system' for automated changes, or a user
   * identifier.
   */
  changed_by?: string;

  /**
   * The value of the field after the change. Null if the field was cleared.
   */
  current_value?: string | null;

  /**
   * The field that was changed.
   */
  field_changed?: 'status' | 'user_classification';

  /**
   * The ID of the insight this audit log entry relates to.
   */
  issue_id?: string;

  /**
   * The value of the field before the change. Null if the field was not previously
   * set.
   */
  previous_value?: string | null;

  /**
   * Optional rationale provided for the change.
   */
  rationale?: string | null;

  /**
   * The zone ID associated with the insight. Only present for zone-level insights.
   */
  zone_id?: number;
}

export interface AuditLogListParams extends CursorPaginationParams {
  /**
   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
   * Zone ID.
   */
  account_id?: string;

  /**
   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
   * Account ID.
   */
  zone_id?: string;

  /**
   * Query param: Filter entries changed before this timestamp (RFC 3339).
   */
  before?: string;

  /**
   * Query param: Filter by the actor that made the change.
   */
  changed_by?: string;

  /**
   * Query param: Filter by the field that was changed.
   */
  field_changed?: 'status' | 'user_classification';

  /**
   * Query param: Sort order for results. Use 'asc' for oldest first or 'desc' for
   * newest first.
   */
  order?: 'asc' | 'desc';

  /**
   * Query param: Filter entries changed at or after this timestamp (RFC 3339).
   */
  since?: string;
}

export interface AuditLogListByInsightParams extends CursorPaginationParams {
  /**
   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
   * Zone ID.
   */
  account_id?: string;

  /**
   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
   * Account ID.
   */
  zone_id?: string;

  /**
   * Query param: Filter entries changed before this timestamp (RFC 3339).
   */
  before?: string;

  /**
   * Query param: Filter by the actor that made the change.
   */
  changed_by?: string;

  /**
   * Query param: Filter by the field that was changed.
   */
  field_changed?: 'status' | 'user_classification';

  /**
   * Query param: Sort order for results. Use 'asc' for oldest first or 'desc' for
   * newest first.
   */
  order?: 'asc' | 'desc';

  /**
   * Query param: Filter entries changed at or after this timestamp (RFC 3339).
   */
  since?: string;
}

export declare namespace AuditLogs {
  export {
    type AuditLogListResponse as AuditLogListResponse,
    type AuditLogListByInsightResponse as AuditLogListByInsightResponse,
    type AuditLogListResponsesCursorPagination as AuditLogListResponsesCursorPagination,
    type AuditLogListByInsightResponsesCursorPagination as AuditLogListByInsightResponsesCursorPagination,
    type AuditLogListParams as AuditLogListParams,
    type AuditLogListByInsightParams as AuditLogListByInsightParams,
  };
}