| POST | /users | Creates a new user. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServicePrincipalApiKey | body | Guid | Yes | The Api key that authorizes the caller to complete the request. Contact your eQuip admin. |
| UserName | body | string | Yes | User login. |
| UserFullName | body | string | Yes | User full name. |
| IsActive | body | boolean | No | Specifies whether the user can log in; defaults to false. |
| EmailAddress | body | string | Yes | User email address. |
| PhoneNumber | body | string | No | User phone number. |
| UserRole | body | string | Yes | The role assigned to the user. |
| SiteScopes | body | List<int> | Yes | List of site Ids authorized for this user. See Api: FindSites. |
| AssetCategoryScopes | body | List<int> | No | List of asset category Ids authorized for this user. See Api: FindAssetCategories. |
| LocationCategoryScopes | body | List<int> | No | List of location category Ids authorized for this user. See Api: FindLocationCategories. |
| PeopleCategoryScopes | body | List<int> | No | List of people category Ids authorized for this user. See Api: FindPeopleCategories. |
| DepartmentScopes | body | List<int> | No | List of department Ids authorized for this user. See Api: FindDepartments. |
| ContractScopes | body | List<int> | No | List of contract Ids authorized for this user. See Api: GetContract. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserUuid | body | Guid | No | User Internal ID of User record |
| UserID | body | Int32 | No | User ID of User record |
| UserName | body | string | No | User Name using which user will be logged in |
| UserFullName | body | string | No | User full name |
| Active | body | boolean | No | Active or InActive |
| EmailAddress | body | string | No | User email address |
| PhoneNumber | body | string | No | User phone number |
| Role | body | string | No | User Role |
| LastLoginDate | body | DateTime? | No | User's last Login date. Last Login Date can be null, If user's never logged in. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/CreateUser HTTP/1.1
Host: equipstage3.e-isg.com
Content-Type: application/json
Content-Length: length
{"UserName":"String","UserFullName":"String","IsActive":false,"EmailAddress":"String","PhoneNumber":"String","UserRole":"String","SiteScopes":[0],"AssetCategoryScopes":[0],"LocationCategoryScopes":[0],"PeopleCategoryScopes":[0],"DepartmentScopes":[0],"ContractScopes":[0]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"UserID":0,"UserName":"String","UserFullName":"String","Active":false,"EmailAddress":"String","PhoneNumber":"String","Role":"String","LastLoginDate":"\/Date(-62135596800000-0000)\/"}