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": "aa415304-447e-42ec-a0ac-f546c072de2d", "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": "d5910a4a-fb14-4093-b803-690d824750de", "Teams": [ { "TeamId": "72db759d-c466-4382-8bff-4f6f23d97c88", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "771660a6-b82b-4780-a1c2-31e7eb495bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6573d439-b368-4051-a006-ef9b89d8c10f", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "771660a6-b82b-4780-a1c2-31e7eb495bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6573d439-b368-4051-a006-ef9b89d8c10f", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e4ce0bde-0955-4274-a612-c4555c8884ac", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "72db759d-c466-4382-8bff-4f6f23d97c88", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "771660a6-b82b-4780-a1c2-31e7eb495bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6573d439-b368-4051-a006-ef9b89d8c10f", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "771660a6-b82b-4780-a1c2-31e7eb495bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6573d439-b368-4051-a006-ef9b89d8c10f", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e4ce0bde-0955-4274-a612-c4555c8884ac", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-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": "d9eebafd-f2c2-4952-b03e-638510715878", "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": "353744ff-11dd-427b-9420-915f8899eecc", "Teams": [ { "TeamId": "df9ce080-5960-4b4b-9b0d-29ae1d4a13a5", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a8dc57f5-f8db-49f1-b8a1-7927529ea516", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0765a57-8b61-4e9a-94de-ad3249bc4f3c", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a8dc57f5-f8db-49f1-b8a1-7927529ea516", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0765a57-8b61-4e9a-94de-ad3249bc4f3c", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "2f8bcf02-0095-438b-a0eb-2a29fadaab95", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "df9ce080-5960-4b4b-9b0d-29ae1d4a13a5", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a8dc57f5-f8db-49f1-b8a1-7927529ea516", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0765a57-8b61-4e9a-94de-ad3249bc4f3c", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a8dc57f5-f8db-49f1-b8a1-7927529ea516", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "MeasurementValueNeededDate": "2025-07-05T19:08:50.7262233-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d0765a57-8b61-4e9a-94de-ad3249bc4f3c", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "2f8bcf02-0095-438b-a0eb-2a29fadaab95", "CreateDate": "2025-07-05T19:08:50.7262233-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-05T19:08:50.7262233-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }