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:52 UTC.

API reference Models

MerchantSecurityPostureDto

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
merchantId required string (uuid) The merchant the counts cover, when they cover exactly one. 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.
isTenantWide required boolean Whether the counts cover every account and key in the tenant, which only an administrator reaches.
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.
scopedMerchantCount required integer (int32) How many merchants the counts cover. Zero alongside `isTenantWide` being `false` means the caller can act for no merchant, so there was nothing to count.
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.
userCount required integer (int32) Accounts in scope among those the scan examined.
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.
usersWithMfa required integer (int32) Accounts with a second factor enrolled.
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.
usersWithStalePassword required integer (int32) Accounts whose password is older than `stalePasswordThresholdDays`, or that have no recorded change at all.
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.
stalePasswordThresholdDays required integer (int32) The age at which a password counts as stale here. Follows the tenant's own rotation period when rotation is enforced, and otherwise falls back to a fixed default so the column still means something for a tenant that has not set a policy.
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.
userCountTruncated required boolean Whether the account scan reached its limit, in which case accounts in scope may never have been examined and every account count here is a floor rather than a total.
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.
apiKeyCount required integer (int32) API keys in scope. A total unless `apiKeyCountTruncated` is set.
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.
dormantApiKeys required integer (int32) Keys with no recorded use for longer than `dormantApiKeyThresholdDays`. A key that has never been used is measured from its creation, so one minted this morning is not reported as dormant.
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.
dormantApiKeyThresholdDays required integer (int32) The idle age at which a key counts as dormant.
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.
apiKeysWithoutSourceRestriction required integer (int32) Keys not bound to any source address, and so usable from anywhere.
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.
apiKeyCountTruncated required boolean Whether more keys are in scope than the scan examined. Unlike the account scan this one is narrowed store-side, so the keys counted are all in scope and only the bound was reached.
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.