No Results
Add User to Domain

EdgeCore version: 4.3.0

Method

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

Used to add a particular user 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 Yes
lock
boolean Specifies whether the user is locked No
lockReason
string Reason why the user is locked No

 

cURL example

curl --location --request POST 'http://localhost:8080/public/domains/edge/users/joe' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' \
--form 'firstName=Joe' \
--form 'lastName=Smith' \
--form 'password=password' \
--form 'lock=false'

Example Response

{
    "apiKey": null,
    "doClass": "AccountUserDO",
    "id": "s3pvsu-k636f3lq69q0",
    "userName": "joe",
    "attributes": {
        "LastName": "Smith",
        "FirstName": "Joe"
    },
    "domainName": "edge",
    "domainId": "s3pvsu-k636f3lq69pj",
    "accountUserMeta": {
        "doClass": "AccountUserMetaDO",
        "creationTime": 1606478977983,
        "currentLogin": 0,
        "failures": 0,
        "lastChange": 1606478977983,
        "lastAdminReset": 1606478977990,
        "changedByAdmin": true,
        "lastFailure": 0,
        "lastLogin": 0,
        "temporaryLock": false,
        "permanentLock": false,
        "lockTime": 0,
        "lockReason": null,
        "acceptedFormNames": []
    },
    "kioskMode": null
}

HTTP Response

Code Status Description
201 Created The request has succeeded and a new resource has been created as a result.
404 Not Found The domain could not be found.

Terms | Privacy