No Results
Update User
Article Contents

EdgeCore version: 4.3.0

Method

PATCH /public/users/{userName}

Used to update a specific user.

Parameters

Name Type Description Mandatory 
userName
 string Username of the user Yes 
domainName
 string Domain the user belongs to No

If domain name is  not included (userName@domainName), it assumes the default domain.

 
firstName
 string First name of the user No 
lastName
 string Last name of the user No 
password
 string New password for the user;

The minimum password length is 8 characters.

 No 
lock
 boolean Specifies whether the user is locked No 
lockReason
 string Reason why the user is locked No

 

cURL example

curl --location --request PATCH 'http://localhost:8080/public/users/jane' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' \
--form 'firstName=Jane' \
--form 'lastName=Doe'

Example Response

{
  "apiKey": null,
  "roleMembership": null,
  "doClass": "AccountUserDO",
  "id": "9uvkg2-h266vjk3v3fb",
  "userName": "jane",
  "attributes": {
    "LastName": "Doe",
    "FirstName": "Jane"
    },
  "domainName": "default",
  "domainId": "9uvkg2-h266vjk3uc90",
  "accountUserMeta": {
    "doClass": "AccountUserMetaDO",
    "creationTime": 1604395115680,
    "currentLogin": 1608283819380,
    "failures": 0,
    "lastChange": 1607941631155,
    "lastAdminReset": 1608283853580,
    "changedByAdmin": true,
    "lastFailure": 0,
    "lastLogin": 1608225197410,
    "temporaryLock": false,
    "permanentLock": false,
    "lockTime": 0,
    "lockReason": "",
    "acceptedFormNames": []
  },
  "kioskMode": null
}

HTTP Response

Code Status Description
200 OK The request has succeeded.
404 Not Found The user could not be found.
Terms | Privacy
×