POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
User| Name | 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": "8c6244d8-9dff-48a9-bd00-5535864dacd0",
"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": "27f48c46-47ba-41a4-bbe6-94adff1fcb51",
"Teams": [
{
"TeamId": "c814e383-80b0-4b0d-b859-859bdd1a81e8",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "85b82988-4ab8-4e26-aa39-e60e2a4658e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df47e8b-3813-47ab-87f1-0109cf722517",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "85b82988-4ab8-4e26-aa39-e60e2a4658e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df47e8b-3813-47ab-87f1-0109cf722517",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "452a1e49-e543-43d7-bccc-0ee75cc3a86a",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "c814e383-80b0-4b0d-b859-859bdd1a81e8",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "85b82988-4ab8-4e26-aa39-e60e2a4658e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df47e8b-3813-47ab-87f1-0109cf722517",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "85b82988-4ab8-4e26-aa39-e60e2a4658e6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1df47e8b-3813-47ab-87f1-0109cf722517",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "452a1e49-e543-43d7-bccc-0ee75cc3a86a",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08: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": "fe46901c-6eb2-433f-8997-5a1ce761e15a",
"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": "5937331b-d7aa-40c3-8708-06c1fa8eb496",
"Teams": [
{
"TeamId": "6db3336a-8056-4ce7-9ac5-388079b0a2c9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "29354ab2-6e4d-447a-90a6-eda3054a7884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c9a46f16-06b3-4994-a3a1-c5d4eb1c2781",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "29354ab2-6e4d-447a-90a6-eda3054a7884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c9a46f16-06b3-4994-a3a1-c5d4eb1c2781",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "3065dac3-4ec4-41d7-89ec-0f4eeba9e5e6",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "6db3336a-8056-4ce7-9ac5-388079b0a2c9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "29354ab2-6e4d-447a-90a6-eda3054a7884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c9a46f16-06b3-4994-a3a1-c5d4eb1c2781",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "29354ab2-6e4d-447a-90a6-eda3054a7884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"MeasurementValueNeededDate": "2026-02-23T03:52:31.073928-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c9a46f16-06b3-4994-a3a1-c5d4eb1c2781",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "3065dac3-4ec4-41d7-89ec-0f4eeba9e5e6",
"CreateDate": "2026-02-23T03:52:31.073928-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T03:52:31.073928-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}