MfaRuleMatchData

MfaRuleMatchData
MfaRuleMatchData

The matchData of a Rule with ruleType MFA, serialized as a JSON string in the Rule matchData field. Selects Hypervisor MFA User Groups through user_group_ids, or every user through all_users true; never names a user and never carries a secret. Other fields are refused with 400 INVALID_MATCH_DATA; a group id that does not exist is 400 UNKNOWN_USER_GROUP. user_group_ids is required unless all_users is true. all_users true refuses a non-empty user_group_ids (absent, null or an empty array is accepted and dropped). Stored with user_group_ids de-duplicated and ascending; only all_users true is stored (false is normalised away). No operation references this schema directly; it describes the shape carried inside the rule request and response.

JSON Example
{
    "user_group_ids": [
        0
    ],
    "process_path": "string",
    "require_pty_tty": false,
    "all_users": false
}
array of integer
user_group_ids
Optional
Constraints: minItems: 1 maxItems: 100

Ids of the Hypervisor MFA User Groups the rule applies to. Required, with at least one id, unless all_users is true; with all_users true a non-empty list is refused (absent, null or an empty array is accepted and dropped)

string
process_path
Optional
Constraints: maxLength: 1024

Optional process path the rule applies to

boolean
require_pty_tty
Optional

Optional: require an interactive PTY/TTY

boolean
all_users
Optional

Optional. When true the rule acts as a catch-all for all SSH logins and user_group_ids must not hold ids. Only true is stored: false or absent is dropped from the stored match data. A value that is not a boolean is refused