POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
UserName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
UserName | string |
None. |
|
FullName | string |
None. |
|
PhoneNumber | string |
None. |
|
string |
None. |
||
IsLockedOut | boolean |
None. |
|
IsApproved | boolean |
None. |
|
Role | Role |
None. |
|
CompanyId | globally unique identifier |
None. |
|
Teams | Collection of Team |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "781007f3-3868-422b-a3dc-f20ae5a51d32", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "495fbde6-c238-4daf-a592-7e10fbde76ce", "Teams": [ { "TeamId": "2600fbbb-3e26-4fd7-8424-73c5735b32f9", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "64dff869-9db5-4e7b-ac2a-9cd68ffd0101", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6c5b474a-af40-4c60-8408-0f82aea62f00", "CreateDate": "2025-10-10T14:55:30.8835411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8835411-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "64dff869-9db5-4e7b-ac2a-9cd68ffd0101", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6c5b474a-af40-4c60-8408-0f82aea62f00", "CreateDate": "2025-10-10T14:55:30.8835411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8835411-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e8b71342-808f-4295-a91a-87f3e52fd277", "CreateDate": "2025-10-10T14:55:30.8835411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8835411-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "2600fbbb-3e26-4fd7-8424-73c5735b32f9", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "64dff869-9db5-4e7b-ac2a-9cd68ffd0101", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6c5b474a-af40-4c60-8408-0f82aea62f00", "CreateDate": "2025-10-10T14:55:30.8835411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8835411-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "64dff869-9db5-4e7b-ac2a-9cd68ffd0101", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8835411-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6c5b474a-af40-4c60-8408-0f82aea62f00", "CreateDate": "2025-10-10T14:55:30.8835411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8835411-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e8b71342-808f-4295-a91a-87f3e52fd277", "CreateDate": "2025-10-10T14:55:30.8835411-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8835411-07:00", "LastModifiedUser": "sample string 6" } ] }
Response Information
Resource Description
On success, the created user.
Name | Description | Type | Additional information |
---|---|---|---|
Data | User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "UserId": "b3d30b19-f4ba-42e6-a69d-ecb0c61f786c", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "2305b372-cd3d-48c5-9e25-24a9a3fe3c69", "Teams": [ { "TeamId": "9705f552-d173-4d75-b8f5-e3806c553df6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "908be4db-3bc5-4d62-bcd0-364e135b1164", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5da13a8-3fc1-4fed-8f8f-5dd4c30cf9cd", "CreateDate": "2025-10-10T14:55:30.8992059-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8992059-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "908be4db-3bc5-4d62-bcd0-364e135b1164", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5da13a8-3fc1-4fed-8f8f-5dd4c30cf9cd", "CreateDate": "2025-10-10T14:55:30.8992059-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8992059-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "54f7a476-ee50-416e-b6b7-37c3a83ba32e", "CreateDate": "2025-10-10T14:55:30.8992059-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8992059-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9705f552-d173-4d75-b8f5-e3806c553df6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "908be4db-3bc5-4d62-bcd0-364e135b1164", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5da13a8-3fc1-4fed-8f8f-5dd4c30cf9cd", "CreateDate": "2025-10-10T14:55:30.8992059-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8992059-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "908be4db-3bc5-4d62-bcd0-364e135b1164", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "MeasurementValueNeededDate": "2025-10-10T14:55:30.8992059-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5da13a8-3fc1-4fed-8f8f-5dd4c30cf9cd", "CreateDate": "2025-10-10T14:55:30.8992059-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8992059-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "54f7a476-ee50-416e-b6b7-37c3a83ba32e", "CreateDate": "2025-10-10T14:55:30.8992059-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:55:30.8992059-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }