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

SecurityOverviewDto

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
userId required string (uuid) The account this overview describes.
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.
userName required string The account's sign-in name, for the administrator view's header. 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.
mfa required SecurityMfaStatusDto SecurityMfaStatusDto Multi-factor enrolment state.
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 SecurityMfaStatusDto:

Field Type Description
enabled required boolean Whether the account has 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.

This body has no documented fields.

password required SecurityPasswordStatusDto SecurityPasswordStatusDto Password age and the tenant's expiry policy applied to it.
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 SecurityPasswordStatusDto:

Field Type Description
hasPassword required boolean Whether the account has a local password 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.
isExternal required boolean Whether the account signs in through an external identity provider, in which case the password and its rotation are that provider's concern and not the platform's.
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.
lastChangedUtc required string (date-time) When the password was last changed, in UTC, or `null` for an account whose password predates the field and has not been changed since. 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.
ageDays required integer (int32) Whole days since the last change, or `null` when `lastChangedUtc` is. 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.
expiryEnforced required boolean Whether the tenant forces passwords to be changed periodically.
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.
expiryPeriodDays required integer (int32) The tenant's rotation period in days. Meaningful only when `expiryEnforced` is `true`; the setting carries a value either way.
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.
expiresUtc required string (date-time) When the current password stops being accepted, in UTC, or `null` when rotation is not enforced or the last-changed instant is unknown. 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.
daysUntilExpiry required integer (int32) Whole days until `expiresUtc`, negative once it has passed, or `null` when there is no expiry to count towards. 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.

sessions required SecuritySessionStatusDto SecuritySessionStatusDto Active login sessions.
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 SecuritySessionStatusDto:

Field Type Description
activeCount required integer (int32) How many sessions the account currently has, including the one making this request.
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.

enforcement required SecurityEnforcementPostureDto SecurityEnforcementPostureDto What the platform actually enforces for this account right now.
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 SecurityEnforcementPostureDto:

Field Type Description
mfaRequirement required MfaRequirement MfaRequirement Whether a second factor is optional, required or turned off for this account.
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.
Optional The account holder chooses. This is the platform default.
Required A second factor is required and the account holder cannot turn it off.
Disabled Two-factor authentication is turned off for the account and cannot be enrolled.
mfaRequirementSource required MfaRequirementSource MfaRequirementSource Which switch decided `mfaRequirement`.
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.
AccountHolder Nothing forces the outcome: the account holder decides.
SubscriptionFeature The subscription feature, which a reseller or the platform operator sets and a tenant administrator cannot override.
TenantPolicy The tenant's own two-factor setting.
usersCanChangeMfa required boolean Whether the account holder may turn their own second factor on and off.
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.
idleTimeoutMinutes required integer (int32) How many minutes of inactivity end the session, from the tenant's idle-circuit setting.
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.
preventConcurrentLogin required boolean Whether the tenant allows only one concurrent login per account.
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.
signInIpRestrictionEnforced required boolean Whether interactive portal access is restricted by source address.
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.

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.