Users: LockUser

Locks the account of the specified user. Use the reason property in the request body to specify why the account was locked.

Permissions

Rooms Version 6: To lock a user who has a lower access level than you, you must have the canManageMemberLowerAccessLevel permission set to true. To lock a user who has the same access level as you, you must have the canManageMemberSameAccessLevel permission set to true

Rooms Version 5: To lock a user, you must have the canManageCompanyMembers permission set to true.

Request

HTTP request

POST /restapi/v2/accounts/{accountId}/users/{userId}/lock

Parameters

Parameter NameValueDescription
Path Parameters
userIdinteger

The id of the user.

accountIdstring

The globally unique identifier (GUID) for the account.

Request Body

details

Responses

CodeDescriptionReference
204

User has been successfully locked out.

400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Users::LockUser

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

LockedOutDetails

Details about a locked account.

reasonstring

The reason the account was locked.

}} />