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. |