---
title: "Is locked"
method: GET
path: "/users/{userId}/islocked"
tags: ["Users"]
---

# Is locked

`GET /users/{userId}/islocked`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/users/{userId}/islocked`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/users/:userId/islocked/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns true if requested user is locked.
            <br />**Note**: This method is available to subscriber users with the *Super Admin* secondary role.

## Path parameters

- `userId` integer, required

## Response `200`

Indicates that the request succeeded and that the requested information is in the response.

- boolean

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters.
- `401`: Indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;
- `500`: Indicates that a generic error has occurred on the server.

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)