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": "a5690de1-f24f-4ba1-8535-16f7493b7948",
"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": "7fe26a33-9367-4cc3-be44-6194ab8fc83c",
"Teams": [
{
"TeamId": "151c955e-a2a5-4e46-8515-3ad800cc314b",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "42d8e1c5-8e10-424a-bcac-5041a80758fc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1aab3f2f-d909-47b4-941a-dfe177596ea7",
"CreateDate": "2026-03-13T12:59:53.6026263-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6026263-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "42d8e1c5-8e10-424a-bcac-5041a80758fc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1aab3f2f-d909-47b4-941a-dfe177596ea7",
"CreateDate": "2026-03-13T12:59:53.6026263-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6026263-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d49943da-befc-4f24-93c2-a629d1b8882c",
"CreateDate": "2026-03-13T12:59:53.6026263-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6026263-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "151c955e-a2a5-4e46-8515-3ad800cc314b",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "42d8e1c5-8e10-424a-bcac-5041a80758fc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1aab3f2f-d909-47b4-941a-dfe177596ea7",
"CreateDate": "2026-03-13T12:59:53.6026263-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6026263-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "42d8e1c5-8e10-424a-bcac-5041a80758fc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6026263-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1aab3f2f-d909-47b4-941a-dfe177596ea7",
"CreateDate": "2026-03-13T12:59:53.6026263-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6026263-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d49943da-befc-4f24-93c2-a629d1b8882c",
"CreateDate": "2026-03-13T12:59:53.6026263-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6026263-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": "2610b858-ca60-4219-83e0-230eb3ef3c9c",
"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": "be783102-de76-40c2-8b5d-ac0afdfefad2",
"Teams": [
{
"TeamId": "9b36b53b-4045-4682-86ae-d77a8d7d1159",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c48a0333-5abf-442b-ba2d-a965b4a2f260",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "43398d1d-edf4-4515-a59a-f06015efd32b",
"CreateDate": "2026-03-13T12:59:53.6182502-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6182502-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c48a0333-5abf-442b-ba2d-a965b4a2f260",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "43398d1d-edf4-4515-a59a-f06015efd32b",
"CreateDate": "2026-03-13T12:59:53.6182502-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6182502-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "386b70c3-f71a-4ce8-84ea-4dd451b731ea",
"CreateDate": "2026-03-13T12:59:53.6182502-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6182502-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "9b36b53b-4045-4682-86ae-d77a8d7d1159",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "c48a0333-5abf-442b-ba2d-a965b4a2f260",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "43398d1d-edf4-4515-a59a-f06015efd32b",
"CreateDate": "2026-03-13T12:59:53.6182502-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6182502-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "c48a0333-5abf-442b-ba2d-a965b4a2f260",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"MeasurementValueNeededDate": "2026-03-13T12:59:53.6182502-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "43398d1d-edf4-4515-a59a-f06015efd32b",
"CreateDate": "2026-03-13T12:59:53.6182502-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6182502-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "386b70c3-f71a-4ce8-84ea-4dd451b731ea",
"CreateDate": "2026-03-13T12:59:53.6182502-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-13T12:59:53.6182502-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}