Interface ClientLogging

These objects represent information about which API Client created or modified a resource. For more information, see Client Logging.

interface ClientLogging {
    anonymousId?: string;
    associate?: CustomerReference;
    clientId?: string;
    customer?: CustomerReference;
    externalUserId?: string;
}

Hierarchy (view full)

Properties

anonymousId? associate? clientId? customer? externalUserId?

Properties

Optional Readonly anonymousId

anonymousId?: string

Indicates that the resource was modified during an anonymous session with the logged ID.

Optional Readonly associate

associate?: CustomerReference

Indicates the Customer who created or modified the resource in the context of a Business Unit. Only present when an Associate acts on behalf of a company using the associate endpoints.

Optional Readonly clientId

clientId?: string

id of the API Client which created the resource.

Optional Readonly customer

customer?: CustomerReference

Indicates the Customer who modified the resource using a token from the password flow.

Optional Readonly externalUserId

externalUserId?: string

External user ID provided by X-External-User-ID HTTP Header.

Settings

Member Visibility

Theme

On This Page

anonymousIdassociateclientIdcustomerexternalUserId