---
title: Lock Users
slug: single-connect-api-3-0-3/lock-users
description: Learn how to use the `curl` command in this document to make a POST request for locking user accounts at a particular URL endpoint. This code example includes JSON format data headers and a payload with a reason, ensuring a seamless account locking proces
docTags: 
createdAt: 2022-11-10T14:21:49.000Z
---

{
  "id": "FbNGzXJWcWY3Hsv95JIpz",
  "data": {
    "url": "{{url}}/aioc-rest-web/rest/user/lockUsers/reasonToLockThem",
    "method": "POST",
    "request": {
      "pathParameters": [],
      "queryParameters": [],
      "headerParameters": [
        {
          "name": "Content-Type",
          "type": "string",
          "example": "application/json",
          "description": ""
        },
        {
          "name": "X-XSRF-TOKEN",
          "type": "string",
          "example": "{{csrftoken}}",
          "description": ""
        }
      ],
      "bodyDataParameters": [
        {
          "name": "body",
          "type": "string",
          "example": "[\"cdc00366-56b6-4874-bd8b-7862549510ab\"]",
          "description": ""
        }
      ],
      "formDataParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Lock Users",
        "jsonExample": "[\n    {\n        \"id\": \"cdc00366-56b6-4874-bd8b-7862549510ab\",\n        \"eid\": \"testuser\",\n        \"personelId\": \"123123\",\n        \"name\": \"testtest\",\n        \"passwordAlgorithm\": \"MD5\",\n        \"password\": \"21232f297a57a5a743894a0e4a801fc3\",\n        \"email\": \"test@test.com\",\n        \"surname\": \"user\",\n        \"internal\": true,\n        \"properties\": {\n            \"phoneNumber\": \"5550000000\",\n            \"ubaThreshold\": \"50\",\n            \"lockReason\": \"Locked by admin\",\n            \"forcePasswordChangeOnNextLogin\": \"true\",\n            \"isLocked\": \"true\"\n        },\n        \"groups\": [\n            \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n            \"DEFAULT_GROUP_SYSYEM_USERS\"\n        ],\n        \"managerGroups\": [],\n        \"lastLogin\": null,\n        \"lastLoginIp\": null,\n        \"recordLimit4Search\": null,\n        \"passwordDirty\": false,\n        \"passwordAutoGenerated\": false,\n        \"phoneNumber\": \"5550000000\",\n        \"forceChangePasswordOnNextLogin\": true,\n        \"lockReason\": \"Locked by admin\",\n        \"unlockOnPasswordChanged\": false,\n        \"unlockTime\": null,\n        \"tempUserEndTime\": null,\n        \"tempUserStartTime\": null,\n        \"tempUser\": false,\n        \"externalDirectorySource\": null,\n        \"userPropertyKey4Search\": null,\n        \"userPropertyValue4Search\": null,\n        \"locked\": true\n    }\n]"
      }
    ],
    "contentType": "application/json",
    "description": "<p>This method locks an existing user.</p>\n<p>Enter the user id in \"Body\" field.</p>\n<p>Mutliple users can be locked at the same time. For this option, use comma separator for id of users.\nEx: [\"user1id\", \"user2id\", \"user3id\"]</p>",
    "examples": {
      "languages": [
        {
          "id": "dzrP6_Xca0rgz0-mGlkwn",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url {{url}}/aioc-rest-web/rest/user/lockUsers/reasonToLockThem \\\n     --header 'accept: application/json'"
        },
        {
          "id": "575Zfig4Ax-40Ip8OfTWO",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"{{url}}/aioc-rest-web/rest/user/lockUsers/reasonToLockThem\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "rlsZBcB7KF_Iu2VCLdtN-",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"{{url}}/aioc-rest-web/rest/user/lockUsers/reasonToLockThem\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "yn7zqotsa8u4qOJUsGH_z",
          "language": "python",
          "label": "Python",
          "code": "import requests\n\nurl = \"{{url}}/aioc-rest-web/rest/user/lockUsers/reasonToLockThem\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "dzrP6_Xca0rgz0-mGlkwn"
    },
    "results": {
      "languages": [
        {
          "id": "yhVhfsHwtYs8nqJ4MPC_T",
          "language": "200",
          "code": "[\n    {\n        \"id\": \"cdc00366-56b6-4874-bd8b-7862549510ab\",\n        \"eid\": \"testuser\",\n        \"personelId\": \"123123\",\n        \"name\": \"testtest\",\n        \"passwordAlgorithm\": \"MD5\",\n        \"password\": \"21232f297a57a5a743894a0e4a801fc3\",\n        \"email\": \"test@test.com\",\n        \"surname\": \"user\",\n        \"internal\": true,\n        \"properties\": {\n            \"phoneNumber\": \"5550000000\",\n            \"ubaThreshold\": \"50\",\n            \"lockReason\": \"Locked by admin\",\n            \"forcePasswordChangeOnNextLogin\": \"true\",\n            \"isLocked\": \"true\"\n        },\n        \"groups\": [\n            \"DEFAULT_GROUP_SYSYEM_ADMINS\",\n            \"DEFAULT_GROUP_SYSYEM_USERS\"\n        ],\n        \"managerGroups\": [],\n        \"lastLogin\": null,\n        \"lastLoginIp\": null,\n        \"recordLimit4Search\": null,\n        \"passwordDirty\": false,\n        \"passwordAutoGenerated\": false,\n        \"phoneNumber\": \"5550000000\",\n        \"forceChangePasswordOnNextLogin\": true,\n        \"lockReason\": \"Locked by admin\",\n        \"unlockOnPasswordChanged\": false,\n        \"unlockTime\": null,\n        \"tempUserEndTime\": null,\n        \"tempUserStartTime\": null,\n        \"tempUser\": false,\n        \"externalDirectorySource\": null,\n        \"userPropertyKey4Search\": null,\n        \"userPropertyValue4Search\": null,\n        \"locked\": true\n    }\n]"
        }
      ],
      "selectedLanguageId": "yhVhfsHwtYs8nqJ4MPC_T"
    }
  },
  "type": "api-oas-v2",
  "children": [
    {
      "text": ""
    }
  ]
}