Interface AuditRecord

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

Hierarchy

  • Record<string, unknown>
    • AuditRecord

Properties

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

Properties

affectedObject

affectedObject: AffectedObject

associatedObjects

associatedObjects: AffectedObject[]

author

author: {
    accountId?: null | string;
    accountType?: string;
    displayName: string;
    externalCollaborator?: boolean;
    isExternalCollaborator?: boolean;
    isGuest?: boolean;
    operations?: null | OperationCheckResult[];
    publicName?: string;
    type: "user";
    userKey?: null | string;
    username?: null | string;
} & {
    [key: string]: unknown;
}

Type declaration

  • OptionalaccountId?: null | string

    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

  • OptionalaccountType?: string
  • displayName: string
  • OptionalexternalCollaborator?: boolean

    This is deprecated. Use isGuest instead.

  • OptionalisExternalCollaborator?: boolean

    This is deprecated. Use isGuest instead. Whether the user is an external collaborator user

  • OptionalisGuest?: boolean

    Whether the user is a guest user

  • Optionaloperations?: null | OperationCheckResult[]
  • OptionalpublicName?: string

    The public name or nickname of the user. Will always contain a value.

  • type: "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.

category

category: string

changedValues

changedValues: ChangedValue[]

creationDate

creationDate: number

The creation date-time of the audit record, as a timestamp.

description

description: string

remoteAddress

remoteAddress: string

summary

summary: string

OptionalsuperAdmin

superAdmin?: boolean

sysAdmin

sysAdmin: boolean

Settings

Member Visibility

On This Page

Properties