Skip to main content
Version: 4.1

SupportHistoryBanContextBan

activated_atstring<date-time>required
planned_end(string | null)<date-time>nullablerequired
detail objectrequired

The full ban explanation of bruteforce_history in detailed mode; null in compact mode.

oneOf
activation objectrequired
atstring<date-time>required
bucket_idstring | nullnullablerequired
window_indexinteger | nullnullablerequired
window_currentinteger | nullnullablerequired
window_previousinteger | nullnullablerequired
totalnumber | nullnullablerequired
effective_limitnumber | nullnullablerequired
planned_end(string | null)<date-time>nullablerequired
kindstringrequired

Possible values: [ban_activated, ban_activation_unconfirmed]

rulestringrequired
stored_rulestringrequired
rule_fingerprintstringrequired
instancestringrequired
activating_requeststringrequired
Constant value: NOT_A_CULPRIT
period_secondsintegerrequired
ban_time_secondsintegerrequired
failed_requestsintegerrequired
end objectrequired

How a ban instance ended as far as recorded. Only released is a recorded end; planned ends are relative to the window end, which is queried_at for ban contexts.

at(string | null)<date-time>nullablerequired
release_sourcestring | nullnullablerequired
reasonstringrequired

Possible values: [released, superseded_by_new_activation, planned_end_passed_unconfirmed, planned_end_after_window, unknown]

contributions objectrequired
crossing_candidate objectrequired
oneOf
atstring<date-time>required
window_currentinteger | nullnullablerequired
event_idstringrequired
basisstringrequired
Constant value: heuristic_crossed_flag
distinct_claimed_namesinteger | nullnullablerequired
windows object[]required
  • Array [
  • expectedinteger | nullnullablerequired
    presentinteger | nullnullablerequired
    windowstringrequired

    Possible values: [activation_window, previous_window]

    statusstringrequired

    Possible values: [complete, loss_detected, aggregate_only, expired, not_applicable]

    evidencestringrequired

    Possible values: [raw, summary, not_read, not_assessed]

    window_indexintegerrequired
    counts_are_upper_boundsbooleanrequired
    summary_check_unreliablebooleanrequired
  • ]
  • items object[]required
  • Array [
  • atstring<date-time>required
    window_indexinteger | nullnullablerequired
    window_currentinteger | nullnullablerequired
    crossedboolean | nullnullablerequired
    account_knownboolean | nullnullablerequired
    claimed_usernamestring | nullnullablerequired
    accountstring | nullnullablerequired
    client_ipstring | nullnullablerequired
    subject_matchboolean | nullnullablerequired
    event_idstringrequired
    request_idstringrequired
    count_sourcestringrequired
    protocolstringrequired
    redactedbooleanrequired
  • ]
  • caveatsstring[]required
    statusstringrequired

    Possible values: [complete, loss_detected, aggregate_only, expired, not_applicable]

    truncatedbooleanrequired
    hits objectrequired
    by_source objectrequired
    property name*integer
    distinct_claimed_namesinteger | nullnullablerequired
    subject_hitsinteger | nullnullablerequired
    claimants object[]required
  • Array [
  • claimed_usernamestring | nullnullablerequired
    accountstring | nullnullablerequired
    hitsintegerrequired
  • ]
  • evidencestringrequired

    Possible values: [raw, summary, not_read, not_assessed]

    countintegerrequired
    count_is_upper_boundbooleanrequired
    interval_approximatebooleanrequired
    unknownsstring[]required
    ban_refstringrequired
    networkstringrequired
    attribution objectrequired

    Under which accounts the listed contributions of one ban were recorded; never who caused the ban. Codes are computed on unredacted rows, so hidden identities never make an answer look exclusive.

    contributing_accountsstring[]nullablerequired

    Distinct recorded accounts of the listed contributions; null unless the caller has history_detail.

    subject_contributions object[]required

    Possible values: <= 50

  • Array [
  • atstring<date-time>required
    window_indexinteger | nullnullablerequired
    window_currentinteger | nullnullablerequired
    ban_activeboolean | nullnullablerequired

    The increment was counted while a ban was active.

    attempt_idstring | nullnullablerequired

    The attempt of this page the request belongs to, if any.

    event_idstringrequired
    request_idstringrequired
    count_sourcestringrequired
    protocolstringrequired
    matched_bystringrequired

    login_claim only means the same login name was typed; it cannot tell the customer from anybody else.

    Possible values: [recorded_account, login_claim]

  • ]
  • counts objectrequired
    listedintegerrequired
    subject_by_accountintegerrequired
    subject_by_login_claimintegerrequired
    other_accountsintegerrequired
    distinct_other_accountsintegerrequired
    no_accountintegerrequired

    Claims that resolved to no account at capture time (often typos).

    unresolvedintegerrequired

    Claims whose account was not recorded; aliases of the subject can hide here.

    counted_while_bannedintegerrequired
    codestringrequired

    SUBJECT_ACCOUNT: contributions recorded under the requested account (a recorded account, never only the same login name), exclusive only with other_contributors none_observed. MULTIPLE_ACCOUNTS: under the requested and another recorded account. OTHER_ACCOUNTS_ONLY: only other recorded accounts with complete evidence and no unresolved, account-less, or subject-name claim. Otherwise NOT_SUFFICIENTLY_ATTRIBUTABLE.

    Possible values: [SUBJECT_ACCOUNT, MULTIPLE_ACCOUNTS, OTHER_ACCOUNTS_ONLY, NOT_SUFFICIENTLY_ATTRIBUTABLE]

    other_contributorsstringrequired

    Possible values: [observed, none_observed, unknown]

    person_attributionstringrequired
    Constant value: NOT_ESTABLISHED
    identities_redactedbooleanrequired
    subject_contributions_truncatedbooleanrequired
    evidence objectrequired
    completenessstringrequired

    Coverage of the contributions only; never evidence of a responsible person, NAT, or VPN.

    Possible values: [complete, aggregate_only, loss_detected, expired, not_applicable, not_read]

    limitationsstring[]required

    Stable codes: ban unknowns, caveats, and attribution limits.

    end objectrequired

    How a ban instance ended as far as recorded. Only released is a recorded end; planned ends are relative to the window end, which is queried_at for ban contexts.

    at(string | null)<date-time>nullablerequired
    release_sourcestring | nullnullablerequired
    reasonstringrequired

    Possible values: [released, superseded_by_new_activation, planned_end_passed_unconfirmed, planned_end_after_window, unknown]

    ban_history objectrequired

    Arguments of bruteforce_history that explain this ban instance.

    fromstring<date-time>required
    untilstring<date-time>required
    ban_refstringrequired
    networkstringrequired
    ban_refstringrequired
    networkstringrequired
    scopestringrequired

    Possible values: [ip, network]

    rulestringrequired
    activation_reasonstringrequired

    Possible values: [FAILURE_THRESHOLD_EXCEEDED, ACTIVATION_UNCONFIRMED]

    subject_relationstringrequired

    How the request relates to the ban; the activating request is never a culprit.

    Possible values: [ACTIVATING_REQUEST, ACTIVATION_UNCONFIRMED, HIT_EXISTING_BAN, ACTIVATION_RACE, INTERVAL_OVERLAP]

    SupportHistoryBanContextBan
    {
    "activated_at": "2024-07-29T15:51:28.071Z",
    "planned_end": "2024-07-29T15:51:28.071Z",
    "detail": {
    "activation": {
    "at": "2024-07-29T15:51:28.071Z",
    "bucket_id": "string",
    "window_index": 0,
    "window_current": 0,
    "window_previous": 0,
    "total": 0,
    "effective_limit": 0,
    "planned_end": "2024-07-29T15:51:28.071Z",
    "kind": "ban_activated",
    "rule": "string",
    "stored_rule": "string",
    "rule_fingerprint": "string",
    "instance": "string",
    "activating_request": "NOT_A_CULPRIT",
    "period_seconds": 0,
    "ban_time_seconds": 0,
    "failed_requests": 0
    },
    "end": {
    "at": "2024-07-29T15:51:28.071Z",
    "release_source": "string",
    "reason": "released"
    },
    "contributions": {
    "crossing_candidate": {
    "at": "2024-07-29T15:51:28.071Z",
    "window_current": 0,
    "event_id": "string",
    "basis": "heuristic_crossed_flag"
    },
    "distinct_claimed_names": 0,
    "windows": [
    {
    "expected": 0,
    "present": 0,
    "window": "activation_window",
    "status": "complete",
    "evidence": "raw",
    "window_index": 0,
    "counts_are_upper_bounds": true,
    "summary_check_unreliable": true
    }
    ],
    "items": [
    {
    "at": "2024-07-29T15:51:28.071Z",
    "window_index": 0,
    "window_current": 0,
    "crossed": true,
    "account_known": true,
    "claimed_username": "string",
    "account": "string",
    "client_ip": "string",
    "subject_match": true,
    "event_id": "string",
    "request_id": "string",
    "count_source": "string",
    "protocol": "string",
    "redacted": true
    }
    ],
    "caveats": [
    "string"
    ],
    "status": "complete",
    "truncated": true
    },
    "hits": {
    "by_source": {},
    "distinct_claimed_names": 0,
    "subject_hits": 0,
    "claimants": [
    {
    "claimed_username": "string",
    "account": "string",
    "hits": 0
    }
    ],
    "evidence": "raw",
    "count": 0,
    "count_is_upper_bound": true,
    "interval_approximate": true
    },
    "unknowns": [
    "string"
    ],
    "ban_ref": "string",
    "network": "string"
    },
    "attribution": {
    "contributing_accounts": "Unknown Type: array,null",
    "subject_contributions": [
    {
    "at": "2024-07-29T15:51:28.071Z",
    "window_index": 0,
    "window_current": 0,
    "ban_active": true,
    "attempt_id": "string",
    "event_id": "string",
    "request_id": "string",
    "count_source": "string",
    "protocol": "string",
    "matched_by": "recorded_account"
    }
    ],
    "counts": {
    "listed": 0,
    "subject_by_account": 0,
    "subject_by_login_claim": 0,
    "other_accounts": 0,
    "distinct_other_accounts": 0,
    "no_account": 0,
    "unresolved": 0,
    "counted_while_banned": 0
    },
    "code": "SUBJECT_ACCOUNT",
    "other_contributors": "observed",
    "person_attribution": "NOT_ESTABLISHED",
    "identities_redacted": true,
    "subject_contributions_truncated": true
    },
    "evidence": {
    "completeness": "complete",
    "limitations": [
    "string"
    ]
    },
    "end": {
    "at": "2024-07-29T15:51:28.071Z",
    "release_source": "string",
    "reason": "released"
    },
    "ban_history": {
    "from": "2024-07-29T15:51:28.071Z",
    "until": "2024-07-29T15:51:28.071Z",
    "ban_ref": "string",
    "network": "string"
    },
    "ban_ref": "string",
    "network": "string",
    "scope": "ip",
    "rule": "string",
    "activation_reason": "FAILURE_THRESHOLD_EXCEEDED",
    "subject_relation": "ACTIVATING_REQUEST"
    }