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": "5ba29d8a-b7b4-4ee6-b8fc-1b1f4338cd5f", "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": "1abdc8c3-7e24-4a72-84d6-ecdd639362af", "Teams": [ { "TeamId": "87cf3a98-801e-440a-a1d8-8074554536ee", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "6acc12a7-9674-4906-9b0f-8839a2479143", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "08a7a1fd-95f1-4b55-bd31-a26d5416ec53", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "6acc12a7-9674-4906-9b0f-8839a2479143", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "08a7a1fd-95f1-4b55-bd31-a26d5416ec53", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "b8134a92-f1ef-4114-a487-528c5408e83d", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "87cf3a98-801e-440a-a1d8-8074554536ee", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "6acc12a7-9674-4906-9b0f-8839a2479143", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "08a7a1fd-95f1-4b55-bd31-a26d5416ec53", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "6acc12a7-9674-4906-9b0f-8839a2479143", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "08a7a1fd-95f1-4b55-bd31-a26d5416ec53", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "b8134a92-f1ef-4114-a487-528c5408e83d", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-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": "a1e39695-ccc7-4928-8371-1de8ca102cca", "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": "a3e9e884-ed9c-4718-bae8-1be0ab46aac8", "Teams": [ { "TeamId": "66f58740-c19f-4980-8b62-9f67ac0a87ba", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "31c2154f-916e-44f5-9ff5-a000672408bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "63674b98-b8c6-409b-8e66-e1bdcb81a54f", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "31c2154f-916e-44f5-9ff5-a000672408bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "63674b98-b8c6-409b-8e66-e1bdcb81a54f", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "77461a54-b75c-4b3d-be37-8c5bc5ab58cb", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "66f58740-c19f-4980-8b62-9f67ac0a87ba", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "31c2154f-916e-44f5-9ff5-a000672408bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "63674b98-b8c6-409b-8e66-e1bdcb81a54f", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "31c2154f-916e-44f5-9ff5-a000672408bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:13.8956959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "63674b98-b8c6-409b-8e66-e1bdcb81a54f", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "77461a54-b75c-4b3d-be37-8c5bc5ab58cb", "CreateDate": "2025-07-31T03:15:13.8956959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:13.8956959-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }