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": "7dcc1a1a-793b-499b-a906-408675776afd",
"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": "07ffc6e0-2f16-4ddd-9a3a-7eadd0abd6d4",
"Teams": [
{
"TeamId": "f988c871-8530-4b0a-84fa-7c5140c9749e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e61ec2fd-28d8-41d7-82a8-af76e08ca73d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d02ee777-1cfa-406d-adc1-e09f367ac732",
"CreateDate": "2026-08-08T20:06:56.0308275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0308275-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e61ec2fd-28d8-41d7-82a8-af76e08ca73d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d02ee777-1cfa-406d-adc1-e09f367ac732",
"CreateDate": "2026-08-08T20:06:56.0308275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0308275-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "db9089d7-f739-4751-b297-1e1dcdedbc10",
"CreateDate": "2026-08-08T20:06:56.0308275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0308275-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f988c871-8530-4b0a-84fa-7c5140c9749e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e61ec2fd-28d8-41d7-82a8-af76e08ca73d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d02ee777-1cfa-406d-adc1-e09f367ac732",
"CreateDate": "2026-08-08T20:06:56.0308275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0308275-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e61ec2fd-28d8-41d7-82a8-af76e08ca73d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0308275-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d02ee777-1cfa-406d-adc1-e09f367ac732",
"CreateDate": "2026-08-08T20:06:56.0308275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0308275-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "db9089d7-f739-4751-b297-1e1dcdedbc10",
"CreateDate": "2026-08-08T20:06:56.0308275-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0308275-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": "4832be3a-c52d-47b0-a316-1bc4f931b1df",
"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": "02f8708b-4fae-46a2-a723-4977f817bf09",
"Teams": [
{
"TeamId": "84970afd-328d-4231-8f4b-c5e0a697cb83",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "50db0d78-fd18-45bd-9747-a0badc99d7fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bd6a1f1e-73c5-46ff-ba78-03d7d4ca6a2d",
"CreateDate": "2026-08-08T20:06:56.0464366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0464366-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "50db0d78-fd18-45bd-9747-a0badc99d7fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bd6a1f1e-73c5-46ff-ba78-03d7d4ca6a2d",
"CreateDate": "2026-08-08T20:06:56.0464366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0464366-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "bac00afe-2564-4ce0-ba6f-7d2e11e59519",
"CreateDate": "2026-08-08T20:06:56.0464366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0464366-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "84970afd-328d-4231-8f4b-c5e0a697cb83",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "50db0d78-fd18-45bd-9747-a0badc99d7fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bd6a1f1e-73c5-46ff-ba78-03d7d4ca6a2d",
"CreateDate": "2026-08-08T20:06:56.0464366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0464366-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "50db0d78-fd18-45bd-9747-a0badc99d7fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"MeasurementValueNeededDate": "2026-08-08T20:06:56.0464366-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bd6a1f1e-73c5-46ff-ba78-03d7d4ca6a2d",
"CreateDate": "2026-08-08T20:06:56.0464366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0464366-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "bac00afe-2564-4ce0-ba6f-7d2e11e59519",
"CreateDate": "2026-08-08T20:06:56.0464366-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T20:06:56.0464366-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}