Sign in
latestOpenAPI 3.1.02026-08-2289226297.1 KB

9930915a1df9

admin

Restrict an account: hide it site-wide and lock it out of login

post/v1/admin.restrictAccount

Request body

$schemastring uri

A URL to the JSON Schema for this object.

reasonstring

Staff-facing reason for the restriction. Required when restricted is true, ignored when it is false.

restrictedboolean required

true hides the account site-wide and locks it out of login, false lifts both

Example request

{
  "$schema": "https://api.steamsets.com/schemas/V1AdminRestrictAccountRequestBody.json",
  "reason": "Ban evasion, see report #412",
  "restricted": true
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

hiddenboolean required

Whether the account is hidden site-wide after this call

reasonstring required

The stored restriction reason, empty when the account is not restricted

restrictedboolean required

Whether a staff restriction is in force after this call

sessionsRevokedinteger required

How many live sessions this call killed

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1AdminRestrictAccountResponseBody.json",
  "hidden": true,
  "reason": "Ban evasion, see report #412",
  "restricted": true,
  "sessionsRevoked": 3
}