---
title: (Soft) Delete a user
slug: soft-delete-a-user
docTags: 
createdAt: 2023-11-07T15:25:31.944Z
---

{
  "id": "yGiRGs9-yLJ31-Z_ncPtG",
  "type": "api-oas-v2",
  "data": {
    "method": "DELETE",
    "url": "https://example.com/scim/v2/Users/{urn}",
    "servers": [
      {
        "url": "https://example.com/scim/v2/Users/{urn}",
        "description": "Jobylon Staging"
      }
    ],
    "name": "(Soft) Delete a user",
    "description": "<p>Soft deletes (deprovisions) a user. This causes the <code>active</code> property to be set to <code>false</code>, meaning the user is no longer able to sign into Jobylon.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "urn",
          "type": "string",
          "description": "<p>User's URN in the \"urn:jobylon:scim:&#x3C;customer_id>:users:&#x3C;user_id>\" format</p>"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "204",
        "description": "No Content",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "fmJkrqvwmTsdvP3pzm0im",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request DELETE \\\n     --url https://example.com/scim/v2/Users/{urn} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "O9hdq8HnkR7eXknY7aU2k",
          "language": "go",
          "label": "Go",
          "code": "package main\n\nimport (\n   \"fmt\"\n   \"net/http\"\n   \"io/ioutil\"\n)\n\nfunc main() {\n\n   url := \"https://example.com/scim/v2/Users/{urn}\"\n   method := \"DELETE\"\n\n   client := &http.Client {\n   }\n   req, err := http.NewRequest(method, url, nil)\n\n   if err != nil {\n      fmt.Println(err)\n      return\n   }\n   req.Header.Add(\"accept\", \"application/json\")\n   req.Header.Add(\"content-type\", \"application/json\")\n\n   res, err := client.Do(req)\n   if err != nil {\n      fmt.Println(err)\n      return\n   }\n   defer res.Body.Close()\n\n   body, err := ioutil.ReadAll(res.Body)\n   if err != nil {\n      fmt.Println(err)\n      return\n   }\n   fmt.Println(string(body))\n}"
        },
        {
          "id": "lSimldMGZnCLW4GXJ7Y5i",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://example.com/scim/v2/Users/{urn}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        },
        {
          "id": "Q3dHzIUBBIEv-wL0cOBmA",
          "language": "javascript",
          "label": "JavaScript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'DELETE',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://example.com/scim/v2/Users/{urn}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "1raBtbg7-JoK9hFghzwzB",
          "language": "java",
          "label": "Java",
          "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n   .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"\");\nRequest request = new Request.Builder()\n   .url(\"https://example.com/scim/v2/Users/{urn}\")\n   .method(\"DELETE\", body)\n   .addHeader(\"accept\", \"application/json\")\n   .addHeader(\"content-type\", \"application/json\")\n   .build();\nResponse response = client.newCall(request).execute();"
        }
      ],
      "selectedLanguageId": "fmJkrqvwmTsdvP3pzm0im"
    },
    "results": {
      "languages": [
        {
          "id": "487FjA7o3-Nlvi-Hm41iw",
          "language": "204",
          "code": "// No Content\n"
        }
      ],
      "selectedLanguageId": "487FjA7o3-Nlvi-Hm41iw"
    }
  },
  "children": [
    {
      "id": "aHy3O0cuHMjZAXv6Qw9sq",
      "type": "paragraph",
      "children": [
        {
          "text": "Soft deletes (deprovisions) a user. This causes the "
        },
        {
          "text": "active",
          "highlight": true
        },
        {
          "text": " property to be set to "
        },
        {
          "text": "false",
          "highlight": true
        },
        {
          "text": ", meaning the user is no longer able to sign into Jobylon."
        }
      ]
    }
  ]
}