Update an existing user

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Updates user profile fields such as role, email, phone, and scope settings.

Endpoints

Request URL

https://{server-hostname}:8383/emsapi/users/{userId}

Scope

Admin.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

userIdstringMandatory

Unique user identifier. To get user id click here. Get User Id

- Request Body

application/json
JSON object
Hide Sub-Attributes
phoneNumberstringOptional

Updated phone number for the user.

roleIDlongOptional

Updated role identifier for the user.

mailIDstringOptional

Updated email address for the user.

authTypestringOptional

Authentication mode for the user.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/emsapi/users/{userId} \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"phoneNumber":"12312","roleID":1,"mailID":"alex.morgan@example.com","authType":"localAuthentication"}'
Show full

Sample Request Body

Update role, username, phone, and scope for an existing user.

Copied!
  {
    "phoneNumber": "12312",
    "roleID": 1,
    "mailID": "alex.morgan@example.com",
    "authType": "localAuthentication"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
userCreatedByDCboolean

Indicates whether the user account was created by Endpoint Central.

domainNamestring

Domain name of the updated user.

userNamestring

Username after update.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

User update succeeds with current and previous identity context.

Copied!
  {
    "userCreatedByDC": true,
    "domainName": "local",
    "userName": "alex.morgan"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.