Interface AuditRecordCreate

interface AuditRecordCreate {
    affectedObject?: AffectedObject;
    associatedObjects?: AffectedObject[];
    author?: {
        displayName?: string;
        operations?: OperationCheckResult[];
        type: "user";
        userKey?: null | string;
        username?: null | string;
    } & {
        [key: string]: unknown;
    };
    category?: string;
    changedValues?: ChangedValue[];
    creationDate?: number;
    description?: string;
    remoteAddress: string;
    summary?: string;
    sysAdmin?: boolean;
}

Hierarchy

  • Record<string, unknown>
    • AuditRecordCreate

Properties

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

Properties

OptionalaffectedObject

affectedObject?: AffectedObject

OptionalassociatedObjects

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.

Optionalauthor

author?: {
    displayName?: string;
    operations?: OperationCheckResult[];
    type: "user";
    userKey?: null | string;
    username?: null | string;
} & {
    [key: string]: unknown;
}

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?: OperationCheckResult[]

    Always defaults to null.

  • type: "user"

    Set to 'user'.

  • OptionaluserKey?: null | string

    This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

  • Optionalusername?: null | string

    This property is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

Optionalcategory

category?: string

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

OptionalchangedValues

changedValues?: ChangedValue[]

The values that were changed in the event.

OptionalcreationDate

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.

Optionaldescription

description?: string

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

remoteAddress

remoteAddress: string

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

Optionalsummary

summary?: string

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

OptionalsysAdmin

sysAdmin?: boolean

Indicates whether the event was actioned by a system administrator.

Settings

Member Visibility

On This Page

Properties