POST Users

Back to endpoints

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	Type	Additional information
UserId	globally unique identifier	None.
UserName	string	None.
FullName	string	None.
PhoneNumber	string	None.
Email	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": "8171f9b3-6f99-4978-9077-267b6d22c1bf",
  "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": "a1516e3e-c558-4705-bd55-7532b33d419b",
  "Teams": [
    {
      "TeamId": "b00f9af9-013f-44ac-bbd7-d32978cb2083",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Users": [],
      "AssetGroups": [
        {
          "AssetGroupId": "87c6077f-f021-4043-8225-355f39cfa00c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "85d8e886-12ad-4aaa-8dfd-1e53ca2dab28",
          "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
          "LastModifiedUser": "sample string 6"
        },
        {
          "AssetGroupId": "87c6077f-f021-4043-8225-355f39cfa00c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "85d8e886-12ad-4aaa-8dfd-1e53ca2dab28",
          "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
          "LastModifiedUser": "sample string 6"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "03ec5703-63b3-4269-96e7-9c330cc3541a",
      "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
      "LastModifiedUser": "sample string 6"
    },
    {
      "TeamId": "b00f9af9-013f-44ac-bbd7-d32978cb2083",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Users": [],
      "AssetGroups": [
        {
          "AssetGroupId": "87c6077f-f021-4043-8225-355f39cfa00c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "85d8e886-12ad-4aaa-8dfd-1e53ca2dab28",
          "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
          "LastModifiedUser": "sample string 6"
        },
        {
          "AssetGroupId": "87c6077f-f021-4043-8225-355f39cfa00c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "85d8e886-12ad-4aaa-8dfd-1e53ca2dab28",
          "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
          "LastModifiedUser": "sample string 6"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "03ec5703-63b3-4269-96e7-9c330cc3541a",
      "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
      "LastModifiedUser": "sample string 6"
    }
  ]
}

Response Information

Resource Description

On success, the created user.

Name	Type	Additional information
Data	User	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "UserId": "ba251289-3b3c-4174-b5e5-fc944545c906",
    "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": "ee9c172d-1696-4221-b520-c85565cf5c06",
    "Teams": [
      {
        "TeamId": "410968a1-55d1-4f04-a605-e7ee1f7252bc",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Users": [],
        "AssetGroups": [
          {
            "AssetGroupId": "36059a20-7894-4554-882e-2b2582d15d95",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "14df282f-6b62-4fed-8506-2766d0ee7faa",
            "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
            "LastModifiedUser": "sample string 6"
          },
          {
            "AssetGroupId": "36059a20-7894-4554-882e-2b2582d15d95",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "14df282f-6b62-4fed-8506-2766d0ee7faa",
            "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
            "LastModifiedUser": "sample string 6"
          }
        ],
        "SourceSystemId": "sample string 3",
        "CompanyId": "a5f2fa34-2f90-4e52-80a3-a849886d6bb7",
        "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
        "LastModifiedUser": "sample string 6"
      },
      {
        "TeamId": "410968a1-55d1-4f04-a605-e7ee1f7252bc",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Users": [],
        "AssetGroups": [
          {
            "AssetGroupId": "36059a20-7894-4554-882e-2b2582d15d95",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "14df282f-6b62-4fed-8506-2766d0ee7faa",
            "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
            "LastModifiedUser": "sample string 6"
          },
          {
            "AssetGroupId": "36059a20-7894-4554-882e-2b2582d15d95",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "MeasurementValueNeededDate": "2025-11-14T11:46:32.4424038-08:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "14df282f-6b62-4fed-8506-2766d0ee7faa",
            "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
            "CreateUser": "sample string 5",
            "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
            "LastModifiedUser": "sample string 6"
          }
        ],
        "SourceSystemId": "sample string 3",
        "CompanyId": "a5f2fa34-2f90-4e52-80a3-a849886d6bb7",
        "CreateDate": "2025-11-14T11:46:32.4424038-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-11-14T11:46:32.4424038-08:00",
        "LastModifiedUser": "sample string 6"
      }
    ]
  },
  "Total": 1,
  "Message": "sample string 1"
}