---
id: patch-user
sidebar_label: Update a user by id
hide_title: true
hide_table_of_contents: true
api: {"operationId":"patchUser","description":"Update a user by id","tags":["Users"],"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","required":true,"writeOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"myusername"},"email":{"description":"The email","type":"string","format":"email","example":"test@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"profile_id":{"description":"The profile_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"mylogin"},"admin":{"description":"Is the user an admin","type":"boolean","example":false},"group_strings":{"description":"The group strings (used in roles later on)","type":"string","example":"Administrator_group,Developer_group"}}}}}}}},"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"description":"The id","type":"string","format":"uuid","readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"The uid","type":"string","minLength":32,"maxLength":32,"readonly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"The name","type":"string","example":"bob"},"email":{"description":"The email","type":"string","format":"email","example":"example@sailpoint.com"},"type":{"description":"The type","type":"string","enum":["NeprofileUser","NeaccessUser"],"default":"NeprofileUser","example":"NeprofileUser"},"title":{"description":"The title","type":"string","example":"mytitle"},"status":{"description":"The status","type":"string","enum":["Active","Disabled"],"example":"Active"},"login":{"description":"The login","type":"string","example":"bob"},"last_login":{"description":"The last login time","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"cookies_accepted_at":{"description":"The time the cookies were accepted at","type":"string","format":"date-time","readOnly":true,"example":"2023-05-01T09:12:28Z"},"preferred_language":{"description":"The preferred language","type":"string","example":"en-US"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The <object> failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/users/{id}","jsonRequestBodyExample":{"user":{"id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","name":"myusername","email":"test@sailpoint.com","type":"NeprofileUser","profile_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","title":"mytitle","status":"Active","login":"mylogin","admin":false,"group_strings":"Administrator_group,Developer_group"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a user by id","description":{"content":"Update a user by id","type":"text/plain"},"url":{"path":["users",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "patch api-method"
info_path: nerm/api/nerm-lifecycle-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Update a user by id' (patch-user)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Update a user by id



Update a user by id

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></ParamsItem></ul></div></details><MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>user</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"The id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} deprecated={undefined} schemaDescription={"The email"} schemaName={"email"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type"} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} defaultValue={"NeprofileUser"}></SchemaItem><SchemaItem collapsible={false} name={"profile_id"} required={false} deprecated={undefined} schemaDescription={"The profile_id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} deprecated={undefined} schemaDescription={"The title"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"The status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} deprecated={undefined} schemaDescription={"The login"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"admin"} required={false} deprecated={undefined} schemaDescription={"Is the user an admin"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"group_strings"} required={false} deprecated={undefined} schemaDescription={"The group strings (used in roles later on)"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Expected response to a valid request

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>user</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"The id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} deprecated={undefined} schemaDescription={"The uid"} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"The name"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} deprecated={undefined} schemaDescription={"The email"} schemaName={"email"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"The type"} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileUser`, `NeaccessUser`]"} defaultValue={"NeprofileUser"}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} deprecated={undefined} schemaDescription={"The title"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"The status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Disabled`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"login"} required={false} deprecated={undefined} schemaDescription={"The login"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"last_login"} required={false} deprecated={undefined} schemaDescription={"The last login time"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"cookies_accepted_at"} required={false} deprecated={undefined} schemaDescription={"The time the cookies were accepted at"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"preferred_language"} required={false} deprecated={undefined} schemaDescription={"The preferred language"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"user\": {\n    \"id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n    \"uid\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n    \"name\": \"bob\",\n    \"email\": \"example@sailpoint.com\",\n    \"type\": \"NeprofileUser\",\n    \"title\": \"mytitle\",\n    \"status\": \"Active\",\n    \"login\": \"bob\",\n    \"last_login\": \"2023-05-01T09:12:28Z\",\n    \"cookies_accepted_at\": \"2023-05-01T09:12:28Z\",\n    \"preferred_language\": \"en-US\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad Request - unable to complete.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem></SchemaTabs></div></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - returned on unhandled exceptions.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>