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": "be9a95db-7bfb-44d9-af01-454fbe37cdb6", "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": "ec8bac0a-39ee-4e84-a813-b71f0a0e14b7", "Teams": [ { "TeamId": "16ce7405-7c81-4f59-9d69-d8a390e0b0c6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "950ff231-e531-478e-801e-79d4c47f4a94", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "78877dcf-1daf-47a1-aa2b-63377363cd24", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "950ff231-e531-478e-801e-79d4c47f4a94", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "78877dcf-1daf-47a1-aa2b-63377363cd24", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "10f5b9e0-d97d-4694-ac93-b6cb6d93fb20", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "16ce7405-7c81-4f59-9d69-d8a390e0b0c6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "950ff231-e531-478e-801e-79d4c47f4a94", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "78877dcf-1daf-47a1-aa2b-63377363cd24", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "950ff231-e531-478e-801e-79d4c47f4a94", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "78877dcf-1daf-47a1-aa2b-63377363cd24", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "10f5b9e0-d97d-4694-ac93-b6cb6d93fb20", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-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": "0ffdda6d-ae91-4395-bb4c-2e09350614a3", "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": "d57b3aac-5251-40d5-8b62-2fad8c690154", "Teams": [ { "TeamId": "2e5b958d-1de0-4226-b41a-82e160155612", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "67c8d2f9-1ec2-48ac-9561-c5f1f4e2040a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "09b7b7fa-44e0-47ff-8db4-22bb9b6f2711", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "67c8d2f9-1ec2-48ac-9561-c5f1f4e2040a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "09b7b7fa-44e0-47ff-8db4-22bb9b6f2711", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "523a13f6-940b-420e-a5d1-ced45eaddf58", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "2e5b958d-1de0-4226-b41a-82e160155612", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "67c8d2f9-1ec2-48ac-9561-c5f1f4e2040a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "09b7b7fa-44e0-47ff-8db4-22bb9b6f2711", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "67c8d2f9-1ec2-48ac-9561-c5f1f4e2040a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "MeasurementValueNeededDate": "2025-07-18T16:01:03.8340153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "09b7b7fa-44e0-47ff-8db4-22bb9b6f2711", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "523a13f6-940b-420e-a5d1-ced45eaddf58", "CreateDate": "2025-07-18T16:01:03.8340153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T16:01:03.8340153-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }