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 operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

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-11-12 05:58 UTC.

API reference SecurityOverview

/api/app/security-overview

GET /api/app/security-overview deprecated

No permission required.

Requires API key scope: admin (Administration)

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

Code sample language

cURL

curl -X GET "{{BASE_URL}}/api/app/security-overview" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/app/security-overview' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, SecurityOverviewApi } from '@winkpg/winkpg-api';

const api = new SecurityOverviewApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.securityOverviewGet();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/app/security-overview', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new SecurityOverviewApi(config);
var result = await api.SecurityOverviewGetAsync();

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/app/security-overview");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.SecurityOverviewApi(client)
    result = api.security_overview_get()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/app/security-overview",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
suppressNulls required query boolean If true, omit properties with null 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.

Request body

application/json , required

Field Type Description

This request body has no documented fields.

Responses

Response status

OK

Body: SecurityOverviewDto SecurityOverviewDto Each item has these 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.

passwordPolicy required SecurityPasswordPolicyDto SecurityPasswordPolicyDto The rules a new password for this account must meet, so a change-password form can show them as the password is typed. Null when the rules could not be read.
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 SecurityPasswordPolicyDto:

Field Type Description
requiredLength required integer (int32) The minimum number of characters a new password must have.
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.
requiredUniqueChars required integer (int32) The minimum number of different characters a new password must contain.
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.
requireDigit required boolean Whether a new password must contain a digit, 0 to 9.
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.
requireLowercase required boolean Whether a new password must contain a lowercase letter, a to z.
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.
requireUppercase required boolean Whether a new password must contain an uppercase letter, A to Z.
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.
requireNonAlphanumeric required boolean Whether a new password must contain a character that is not a letter or a digit.
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.
minimumLengthSetBy required string Who set `requiredLength`, worded for the account holder (for example, `by your reseller`), when a reseller or merchant minimum raised it above the tenant's. Null when the minimum length is the tenant's own. 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.
breachCheckEnabled required boolean Whether the tenant has the advisory password breach check on, so the password form also shows whether a new password appears in known data breaches. Advisory only: it is not a rule the server enforces, and a breached password is not refused on its 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.

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.
administratorPasskeyRequired required boolean Whether the administrator passkey policy's Required value reaches this account: the passkey is its only second factor, unless an exception is live.
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.
administratorPasskeyExceptionEndsAt required string (date-time) When this account's live exception to the administrator passkey policy ends, in UTC, or `null` when none is live. While it is, the account may sign in with an authenticator app. 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.
passwordRules required SecurityPasswordRulesEnforcementDto SecurityPasswordRulesEnforcementDto The password and lockout rules in force for the tenant, as the PCI DSS password policy leaves them: the effective values, so they reflect the policy switch and its bounds.
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 response has no documented body fields.

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
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 response has no documented body fields.

  1. 400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
  2. 401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
  3. 403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
  4. 404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
  5. 500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
  6. 501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
  7. default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
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 RemoteServiceErrorInfo:

Field Type Description
code required string 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.
message required string 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.
details required string 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.
data required object 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.
validationErrors required array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo 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.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

  • ApiKey with scopes

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.