Invite User

Owned by Ragheb Bou Dargham (Unlicensed)
Last updated: Jul 16, 2019

General Information

ServiceAPIMethod
urac/admin/inviteUserPost


Data Model: Users

Workflow: 

Input

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
usernameQueryNOStringN/Athe user username (either username or email should be provided)
emailQueryNOStringN/Athe user email (either username or email should be provided)
groupsbodyNOArrayArray of strings
pin
bodyNOObject


code
YESBoolean
set to True to create a random generated code 

allowed
YESBoolean

set to True if this user is allowed to start pin code login


Output

Valid Response

Valid Response Sample
{
	"result": true,
	"data": {
		"..."	
	}
}


Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[411],
        "details":[
            {
                "code":411,
                "message":"invalid user id provided"
            }
        ]
    }
}



Error Codes


Code
Description
405Unable to find User. Please try again.
411invalid user id provided


Example (CURL)

Request

Calling Get User API
 > CURL -X POST http://127.0.0.1:4000/urac/admin/inviteUser?username=5718a32f0e811ab5a0ca08b3 --data '{"groups":"[xyz"], "pin":{"code": "123", "allowed": true}}}'

Response

Get User API response
{
    "result": true,
    "data": true
}