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": "6aeee45b-fab2-4953-afc6-688dcbbfbb0f", "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": "618f7d4e-e08d-4948-bb10-e0b90918fa11", "Teams": [ { "TeamId": "6a84f6e4-475b-4b90-999a-44413fc91b2c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "18023209-3ca9-4131-ae3a-3f11137daedb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c72ee05d-628f-4e7b-87fd-f020e185b3e0", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "18023209-3ca9-4131-ae3a-3f11137daedb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c72ee05d-628f-4e7b-87fd-f020e185b3e0", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "844df3fd-108c-4483-b7b0-7e731201b856", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "6a84f6e4-475b-4b90-999a-44413fc91b2c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "18023209-3ca9-4131-ae3a-3f11137daedb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c72ee05d-628f-4e7b-87fd-f020e185b3e0", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "18023209-3ca9-4131-ae3a-3f11137daedb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c72ee05d-628f-4e7b-87fd-f020e185b3e0", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "844df3fd-108c-4483-b7b0-7e731201b856", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-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": "8b914cf0-62eb-4496-8fed-81ef07ae58c6", "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": "5f9f4677-a596-4206-9a44-9f6bdfa2612c", "Teams": [ { "TeamId": "511e0e51-2893-4539-aab4-749bace657cc", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "54f7ba4a-1dd4-487e-a596-0598bd59c5b7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0a91b39-3440-452c-83d4-8e1aa0a76e9a", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "54f7ba4a-1dd4-487e-a596-0598bd59c5b7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0a91b39-3440-452c-83d4-8e1aa0a76e9a", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "159d5642-a113-41c7-8333-c22e36e2a82c", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "511e0e51-2893-4539-aab4-749bace657cc", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "54f7ba4a-1dd4-487e-a596-0598bd59c5b7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0a91b39-3440-452c-83d4-8e1aa0a76e9a", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "54f7ba4a-1dd4-487e-a596-0598bd59c5b7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "MeasurementValueNeededDate": "2025-06-02T02:30:00.6631745-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0a91b39-3440-452c-83d4-8e1aa0a76e9a", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "159d5642-a113-41c7-8333-c22e36e2a82c", "CreateDate": "2025-06-02T02:30:00.6631745-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T02:30:00.6631745-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }