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": "4bf20dc5-c17b-423e-8098-9795c495638d", "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": "b7e890b8-4953-4df7-a4e0-03023a6c9513", "Teams": [ { "TeamId": "63fdf202-63e0-4e8c-8b69-17e0b2eaeb1e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5a3e841a-3d7d-4c29-b390-87732e44f800", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3d7402e3-b880-44dd-ba58-d92d82845142", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5a3e841a-3d7d-4c29-b390-87732e44f800", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3d7402e3-b880-44dd-ba58-d92d82845142", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "dae4854d-9f6b-41d9-a887-a37669957363", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "63fdf202-63e0-4e8c-8b69-17e0b2eaeb1e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5a3e841a-3d7d-4c29-b390-87732e44f800", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3d7402e3-b880-44dd-ba58-d92d82845142", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5a3e841a-3d7d-4c29-b390-87732e44f800", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3d7402e3-b880-44dd-ba58-d92d82845142", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "dae4854d-9f6b-41d9-a887-a37669957363", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-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": "2c3907f9-17cb-4000-9213-340816941423", "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": "e6d5b8f8-32aa-4386-8262-ae1340180ee1", "Teams": [ { "TeamId": "d7a7834c-a18f-4e05-a8b6-9b88bb26e0ce", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "dfb6df5e-6694-4bf0-b383-9f9962497e31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7534d3f0-dad6-4d11-bb89-bd9695e012c3", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "dfb6df5e-6694-4bf0-b383-9f9962497e31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7534d3f0-dad6-4d11-bb89-bd9695e012c3", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4cebe710-d53c-4e0d-a848-71865703427e", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d7a7834c-a18f-4e05-a8b6-9b88bb26e0ce", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "dfb6df5e-6694-4bf0-b383-9f9962497e31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7534d3f0-dad6-4d11-bb89-bd9695e012c3", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "dfb6df5e-6694-4bf0-b383-9f9962497e31", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "MeasurementValueNeededDate": "2025-06-30T20:38:35.7355404-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7534d3f0-dad6-4d11-bb89-bd9695e012c3", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4cebe710-d53c-4e0d-a848-71865703427e", "CreateDate": "2025-06-30T20:38:35.7355404-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T20:38:35.7355404-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }