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": "c79d33ac-4dfb-4795-8931-6f4e5c8b1bab", "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": "4521b05e-ebc3-41d5-a049-6e77ba3bbb81", "Teams": [ { "TeamId": "b623284c-12af-45e3-bd28-c46d8900ad1c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "7f99d5a8-ff2f-4ad9-acb5-243c8407edf1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5b5aa10e-2865-498b-a255-d9877d75c803", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "7f99d5a8-ff2f-4ad9-acb5-243c8407edf1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5b5aa10e-2865-498b-a255-d9877d75c803", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d9b357d0-6746-4007-abda-1d581ed12952", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "b623284c-12af-45e3-bd28-c46d8900ad1c", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "7f99d5a8-ff2f-4ad9-acb5-243c8407edf1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5b5aa10e-2865-498b-a255-d9877d75c803", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "7f99d5a8-ff2f-4ad9-acb5-243c8407edf1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5b5aa10e-2865-498b-a255-d9877d75c803", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d9b357d0-6746-4007-abda-1d581ed12952", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-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": "702b8234-5786-4020-84f0-b6cd850d08fd", "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": "273fe9cf-f344-40e9-a9bd-c4e950c6017c", "Teams": [ { "TeamId": "02b97fc2-e9a2-4f86-abf2-38b3c1f139a8", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e3597c33-3314-48ae-bde0-ad341ff9ada5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "aedfd072-45e3-45ed-baa8-2423c1809a03", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e3597c33-3314-48ae-bde0-ad341ff9ada5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "aedfd072-45e3-45ed-baa8-2423c1809a03", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1996bb2d-556a-45d6-8562-cc514dacd538", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "02b97fc2-e9a2-4f86-abf2-38b3c1f139a8", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e3597c33-3314-48ae-bde0-ad341ff9ada5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "aedfd072-45e3-45ed-baa8-2423c1809a03", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e3597c33-3314-48ae-bde0-ad341ff9ada5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "MeasurementValueNeededDate": "2025-07-31T17:57:01.4594763-07:00", "SourceSystemId": "sample string 3", "CompanyId": "aedfd072-45e3-45ed-baa8-2423c1809a03", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1996bb2d-556a-45d6-8562-cc514dacd538", "CreateDate": "2025-07-31T17:57:01.4594763-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:57:01.4594763-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }