WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.

API reference Models

ImpersonationAccessHistoryDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
windowStartUtc required string (date-time) Where the window starts, in UTC.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
windowEndUtc required string (date-time) Where the window ends, in UTC.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
records required array of ImpersonationAccessRecordDto array of ImpersonationAccessRecordDto The sessions, newest first. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each ImpersonationAccessRecordDto:

Field Type Description
merchantId required string (uuid) The merchant the session viewed as.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
merchantName required string The merchant's name when the session started. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
actorDisplayName required string The acting person's display name. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
actorOrganisation required string Who the acting person works for: the reseller's name, or the platform's product name for platform staff. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
mode required ImpersonationSessionMode ImpersonationSessionMode The session mode.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Unspecified No mode has been derived. Treated as the most restrictive posture everywhere (equivalent to ReadOnly for enforcement), so an uninitialized value can never widen a session.
ReadOnly Every permission classified Write, Delete or Manage is denied for the duration of the session. Read-classified permissions evaluate against the impersonated scope exactly as in Full.
Intersect A permission is granted only where the impersonated scope grants it and the acting user's own roles or direct grants allow it. The permission-type classifier is not consulted: what the acting user may not do outside the session, they may not do inside it.
Full The impersonated scope's own grants apply unmodified, including every write, delete and manage surface. The phase 1 read-write posture.
startedAtUtc required string (date-time) When the session started, in UTC.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
endedAtUtc required string (date-time) When the session ended, in UTC, or `null` when no end was recorded. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
recordsSaved required integer (int32) How many records were saved during the session, or `null` when the count is not available (the audit trail was too large to count within bounds, or could not be read). nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

truncated required boolean Whether the underlying log read stopped at its bound before the window was exhausted, so older sessions inside the window may be missing.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.