No Results
Update Domain User
Article Contents

EdgeCore version: 4.3.0

Method

PATCH /public/domains/{domainName}/users/{userName}

Used to update a particular user belonging to a specific domain.

Parameters

Name Type Description Mandatory 
domainName
 string Domain Yes 
userName
 string Username of the user you want to add Yes 
firstName
 string User’s first name No 
lastName
 string User’s last name No 
password
 string User’s password 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/domains/edge/users/dean' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' \
--form 'firstName=Dean' \
--form 'lastName=Winchester' \
--form 'lock=false'

Example Response

{
    "apiKey": null,
    "doClass": "AccountUserDO",
    "id": "s3pvsu-k636f3lq69q6",
    "userName": "dean",
    "attributes": {
        "LastName": "Winchester",
        "FirstName": "Dean"
    },
    "domainName": "edge",
    "domainId": "s3pvsu-k636f3lq69pj",
    "accountUserMeta": {
        "doClass": "AccountUserMetaDO",
        "creationTime": 1606479678928,
        "currentLogin": 0,
        "failures": 0,
        "lastChange": 1606479678928,
        "lastAdminReset": 1606479866085,
        "changedByAdmin": true,
        "lastFailure": 0,
        "lastLogin": 0,
        "temporaryLock": false,
        "permanentLock": false,
        "lockTime": 0,
        "lockReason": null,
        "acceptedFormNames": []
    },
    "kioskMode": null
}

HTTP Response

Code Status Description
200 OK The request has succeeded.
404 Not Found The domain could not be found.

Or

The user could not be found.
Terms | Privacy
×