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": "eaf497bb-188f-4c17-a455-26a5ccc1bb6d", "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": "30186cd0-7b5d-472e-8c67-1ddd7ff238cc", "Teams": [ { "TeamId": "22dd1b1b-5a31-474f-97e0-581130b8da98", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "61c44f97-2712-4438-b2ca-3cff0144960e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c18c27b4-339b-473d-9e1f-b4613bb92840", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "61c44f97-2712-4438-b2ca-3cff0144960e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c18c27b4-339b-473d-9e1f-b4613bb92840", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4a2ce5ea-9f2e-4646-9f9c-1f0bcb18f342", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "22dd1b1b-5a31-474f-97e0-581130b8da98", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "61c44f97-2712-4438-b2ca-3cff0144960e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c18c27b4-339b-473d-9e1f-b4613bb92840", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "61c44f97-2712-4438-b2ca-3cff0144960e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c18c27b4-339b-473d-9e1f-b4613bb92840", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4a2ce5ea-9f2e-4646-9f9c-1f0bcb18f342", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-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": "8025a41c-a52b-43f9-acfc-581e8963b02d", "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": "bf3d6fd5-72a7-4527-a1d9-1b3690256705", "Teams": [ { "TeamId": "66e4d871-0f06-4ddb-81aa-7e5398c90e62", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d7411957-d83f-44f4-a119-19109b29a5cf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "510f11c5-bba3-456e-ac39-f5c15fe7b645", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d7411957-d83f-44f4-a119-19109b29a5cf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "510f11c5-bba3-456e-ac39-f5c15fe7b645", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7a0fe437-b933-460e-8676-a1fac9fc9f5c", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "66e4d871-0f06-4ddb-81aa-7e5398c90e62", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d7411957-d83f-44f4-a119-19109b29a5cf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "510f11c5-bba3-456e-ac39-f5c15fe7b645", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d7411957-d83f-44f4-a119-19109b29a5cf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "MeasurementValueNeededDate": "2025-04-24T13:53:29.8083237-07:00", "SourceSystemId": "sample string 3", "CompanyId": "510f11c5-bba3-456e-ac39-f5c15fe7b645", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7a0fe437-b933-460e-8676-a1fac9fc9f5c", "CreateDate": "2025-04-24T13:53:29.8083237-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:53:29.8083237-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }