---
title: "Restrict an account: hide it site-wide and lock it out of login"
method: POST
path: "/v1/admin.restrictAccount"
tags: ["admin"]
---

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

`POST /v1/admin.restrictAccount`

## Request body

- V1AdminRestrictAccountRequestBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `id` IDSearch
    - `accountId` integer — Account ID to search for
    - `steamId64` string — SteamID64 to search for
  - `reason` string — Staff-facing reason for the restriction. Required when restricted is true, ignored when it is false.
  - `restricted` boolean, required — true hides the account site-wide and locks it out of login, false lifts both
  - `vanity` VanitySearch
    - `type` 'steam' | 'internal', required — Which type of vanity to search for
    - `value` string, required — Vanity to search for

## Response `200`

OK

- V1AdminRestrictAccountResponseBody
  - `$schema` string, uri — A URL to the JSON Schema for this object.
  - `hidden` boolean, required — Whether the account is hidden site-wide after this call
  - `reason` string, required — The stored restriction reason, empty when the account is not restricted
  - `restricted` boolean, required — Whether a staff restriction is in force after this call
  - `sessionsRevoked` integer, required — How many live sessions this call killed

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/steamsets/apis/steamsets-api.md) · [All operations](https://skmtc.net/steamsets/apis/steamsets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steamsets/steamsets-api/revisions/9930915a1df9/schema)