Docs home

User Block

Blocks a user in your institute. A blocked user is logged out of every device at once and can't use their account until unblocked. Use "User Unblock" to reverse it.

POST/admin/institution/user/block
User Block
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/admin/institution/user/block' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"user_id":69007}'
{
  "code": 200,
  "message": "Success",
  "response": {
    "status": 1
  }
}

Access: Institute admins only. The user must belong to the organization in your ORGID header.

Request body: form-data with one field, JSONString, containing this JSON:

BodyJSONString
user_idintegerrequired
The user to block.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
responseobject
Show child attributesHide child attributes
Example: 1

Notes: Fails with "Not Authorized" if you aren't an institute admin, or "You Cannot Block This User" if the user isn't in your organization. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI