Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface CreateAuditRecord

    interface CreateAuditRecord {
        affectedObject?: AffectedObject;
        associatedObjects?: AffectedObject[];
        author?: { displayName?: string; operations?: {}; type: string };
        category?: string;
        changedValues?: ChangedValue[];
        creationDate?: number;
        description?: string;
        remoteAddress: string;
        summary?: string;
        sysAdmin?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    affectedObject? associatedObjects? author? category? changedValues? creationDate? description? remoteAddress summary? sysAdmin?

    Properties

    affectedObject?: AffectedObject
    associatedObjects?: AffectedObject[]

    Objects that were associated with the event. For example, if the event was a space permission change then the associated object would be the space.

    author?: { displayName?: string; operations?: {}; type: string }

    The user that actioned the event. If author is not specified, then all author properties will be set to null/empty, except for type which will be set to 'user'.

    Type declaration

    • OptionaldisplayName?: string

      The name that is displayed on the audit log in the Confluence UI.

    • Optionaloperations?: {}

      Always defaults to null.

    • type: string

      Set to 'user'.

    category?: string

    The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI.

    changedValues?: ChangedValue[]

    The values that were changed in the event.

    creationDate?: number

    The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the Confluence UI. If the creationDate is not specified, then it will be set to the timestamp for the current date-time.

    description?: string

    A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence UI.

    remoteAddress: string

    The IP address of the computer where the event was initiated from.

    summary?: string

    The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI.

    sysAdmin?: boolean

    Indicates whether the event was actioned by a system administrator.

    Settings

    Member Visibility

    On This Page

    Properties