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": "5b6babdb-bab5-44b2-87ac-54cbc63ffae3",
"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": "7a462b18-cc96-4adc-8536-2775a5daab7f",
"Teams": [
{
"TeamId": "0b203510-20cf-405c-b894-8a5130b201fe",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d46c3e0a-df47-4a1c-92d5-34223623ae5f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a038100-3df2-4980-91f9-732f596a63e8",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d46c3e0a-df47-4a1c-92d5-34223623ae5f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a038100-3df2-4980-91f9-732f596a63e8",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "af7cb028-fa6c-487e-a2e5-6a4d9efa1030",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "0b203510-20cf-405c-b894-8a5130b201fe",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "d46c3e0a-df47-4a1c-92d5-34223623ae5f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a038100-3df2-4980-91f9-732f596a63e8",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "d46c3e0a-df47-4a1c-92d5-34223623ae5f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0a038100-3df2-4980-91f9-732f596a63e8",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "af7cb028-fa6c-487e-a2e5-6a4d9efa1030",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-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": "284fdfd0-1c41-4605-8c25-135b9ac061b4",
"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": "54599bb3-6d48-40d3-8187-57999f5de38c",
"Teams": [
{
"TeamId": "f9161fb7-dc52-48ad-bd26-fc479cc3a9d9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a9703f23-8679-4a20-9454-b1388539b000",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "476ae2b5-ce5b-49f7-a384-dec017caeff0",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a9703f23-8679-4a20-9454-b1388539b000",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "476ae2b5-ce5b-49f7-a384-dec017caeff0",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "aaeda83f-6827-47fd-a3af-a5c7f35547d9",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "f9161fb7-dc52-48ad-bd26-fc479cc3a9d9",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "a9703f23-8679-4a20-9454-b1388539b000",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "476ae2b5-ce5b-49f7-a384-dec017caeff0",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "a9703f23-8679-4a20-9454-b1388539b000",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"MeasurementValueNeededDate": "2026-11-22T08:01:01.7040679-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "476ae2b5-ce5b-49f7-a384-dec017caeff0",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "aaeda83f-6827-47fd-a3af-a5c7f35547d9",
"CreateDate": "2026-11-22T08:01:01.7040679-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T08:01:01.7040679-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}