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": "664d0de3-cfc4-4177-b579-2232259a77fe", "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": "5addc614-275c-4133-8fcf-91756d83c447", "Teams": [ { "TeamId": "795f41bd-ef6a-45d8-9aac-7deea1aced4d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3178e4ae-4c52-458a-9bc0-5b2fd7ddcdf0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d50d360e-12e2-4e68-a2db-2e083e0e421c", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3178e4ae-4c52-458a-9bc0-5b2fd7ddcdf0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d50d360e-12e2-4e68-a2db-2e083e0e421c", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "973e0e52-7b32-4d30-a61c-16e479ab2c74", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "795f41bd-ef6a-45d8-9aac-7deea1aced4d", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3178e4ae-4c52-458a-9bc0-5b2fd7ddcdf0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d50d360e-12e2-4e68-a2db-2e083e0e421c", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3178e4ae-4c52-458a-9bc0-5b2fd7ddcdf0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d50d360e-12e2-4e68-a2db-2e083e0e421c", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "973e0e52-7b32-4d30-a61c-16e479ab2c74", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-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": "0bd58742-4209-44fc-b2ae-7d5dd126d33e", "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": "3ed0c415-4305-4261-9de8-6b770fca9c10", "Teams": [ { "TeamId": "633576ce-8d83-49ae-bb2f-26c96ff59425", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9cfcefb8-563d-4c46-b1f6-1ac6713af333", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b44bcde3-f58c-4267-a9f8-6beda6859c8e", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9cfcefb8-563d-4c46-b1f6-1ac6713af333", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b44bcde3-f58c-4267-a9f8-6beda6859c8e", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "6490afe4-473c-47bf-ba78-0d2b9b3865a9", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "633576ce-8d83-49ae-bb2f-26c96ff59425", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9cfcefb8-563d-4c46-b1f6-1ac6713af333", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b44bcde3-f58c-4267-a9f8-6beda6859c8e", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9cfcefb8-563d-4c46-b1f6-1ac6713af333", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "MeasurementValueNeededDate": "2025-10-20T22:27:02.2712263-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b44bcde3-f58c-4267-a9f8-6beda6859c8e", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "6490afe4-473c-47bf-ba78-0d2b9b3865a9", "CreateDate": "2025-10-20T22:27:02.2712263-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T22:27:02.2712263-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }