Create User

Release Time

12/15/2017

Views

918 times

Tags

Create user service desk APIs API ERROR OUTPUT execution

Description

Creates a new user
URL:https://subdomain.domainname/clientapi /index.php?serviceName=createuser

This function can be executed via following url: https://subdomain.domainname/clientapi

Input Parameters

Name	Required / Optional	Type	Description
email	Required	varchar	User Email
name	Required	varchar	User Name
organizationId	Optional	int	User Organization Id
customFields	Optional	json	Custom Field Values

Input Header Parameters

Name	Required / Optional	Type	Description
Content-Type	Required	application/json	Content Type
Authorization	Required*	base64	Valid Api Key from SD Manage-> Api Keys
X-ACCESS-TOKEN	Required*	string	3rd Party Authentication API Definition https://developer.comodo.com/frontend/web/topic/comodo-one-3rd-party-company-api-definition https://developer.comodo.com/frontend/web/topic/token-validation-service https://developer.comodo.com/frontend/web/topic/token-renew-service
* Customer should send Authorization or X-ACCESS-TOKEN

Execution

Sample execution can be handled via Postman Application.

{
    "name": "user name",
    "email":"sample@gmail.com",
    "customFields": {
      "phone" : "6161X889",
      "notes" : "notes",
      "UniqueId" : "hgsqjhdqwd11"
    }
}

Header part can be handled via Postman Application

Header part can be handled via Postman Application
Content-Type : application/json
Authorization : B8ADA99D912E48A8735D3291CE60493A
 or
X-ACCESS-TOKEN : eyJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0ZWRCeSI6InNkIiwibmJmIjoxNDk5MjUzNjk4LCJzY29wZSI6InNkc3RhZ2luZy1tc3AiLCJpc3MiOiJjMXBvcnRhbCIsImN1c3RvbWVySWQiOiI1OTJmYmRjZWRiYTcwYTExNTQzMWExZTUiLCJleHAiOjE0OTkyNTcyOTgsInRva2VuVHlwZSI6ImJlYXJlciIsImlhdCI6MTQ5OTI1MzY5OCwidXNlcklkIjoiMTI0MTI0MTEyNCIsImp0aSI6ImVmNjhhOTA1ODNjOWVhNjQ5ZTI4OWNkNmZkMGVhM2VhNDQ5Y2Q1N2QyNGYxMjQxYTY1MzNlYjBlNTZmMDZmMTgyY2FlNmE3NWViMmMwODA5In0.hKqaMAH2JNCfeG_OWv1TXVeKIzjgvZC7xo887Zt85ZA

Success Output

{
    "message": "User created",
    "code": 200,
    "status": "SUCCESS",
    "data": {
        "userId": "1"
    }
}

Error Output

Success Output
{
    "message": "email should be valid email address",
    "code": 404,
    "status": "ERROR"
}