Edge Technologies, Inc. | Documentation

EdgeCore version: 4.3.0

Method

POST /public/roles/{roleName}/users/{userName}@{domainName}

Used to add a user to a role.

Parameters

Name	Type	Description	Mandatory
roleName	string	Name of the role you want to add	Yes
userName	string	Username	Yes
domainName	string	Domain name	Yes

cURL example

curl --location --request POST 'http://localhost:8080/public/roles/Editor/users/qa@dev' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5'

Example Response

{
    "apiKey": null,
    "doClass": "AccountUserDO",
    "id": "qcq9rq-bl7j1jgau249",
    "userName": "qa",
    "attributes": {
        "LastName": "Washington",
        "FirstName": "George"
    },
    "domainName": "dev",
    "domainId": "qcq9rq-bl7j1jgau245",
    "accountUserMeta": {
        "doClass": "AccountUserMetaDO",
        "creationTime": 1594929388835,
        "currentLogin": 0,
        "failures": 0,
        "lastChange": 1594929388835,
        "lastAdminReset": 1594929497835,
        "changedByAdmin": true,
        "lastFailure": 0,
        "lastLogin": 0,
        "temporaryLock": false,
        "permanentLock": false,
        "lockTime": 0,
        "lockReason": null,
        "acceptedFormNames": []
    },
    "kioskMode": null
}

Response Fields

Name	Type	Description
apiKey	string	API key
doClass	string	Name of the object’s class
userName	string	Name of the user
attributes	object	First and last name of the user
domainName	string	The domain to which the user belongs
domainId	string	The ID of the user’s domain
accountUserMeta	object	Information about user’s last login, account lock, etc.
kioskMode	object	If set, contains kiosk mode configuration for this user

HTTP Response

Code	Status	Description
201	Created	The request has succeeded and a new resource has been created as a result.