DELETE Users

Deletes the given user. The user to delete cannot be in the Owner role. Also, the user making this request cannot delete their own account.

Request Information

URI Parameters

None.

Body Parameters

User to be deleted

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": "47c3f471-7522-4175-a0b1-52658817c0b7",
  "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": "69e86573-1665-4bf9-bfff-9b820f13995f",
  "Teams": [
    {
      "TeamId": "b69f7e0e-8593-49f1-8a6a-3b90ffec2f7f",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Users": [],
      "AssetGroups": [
        {
          "AssetGroupId": "b5c28b21-4e38-4010-b887-59da8d220767",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "MeasurementValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "7bcd43a6-f9c5-4775-b0bb-5b90c661b03d",
          "CreateDate": "2024-11-21T04:57:11.2723384-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T04:57:11.2723384-08:00",
          "LastModifiedUser": "sample string 6"
        },
        {
          "AssetGroupId": "b5c28b21-4e38-4010-b887-59da8d220767",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "MeasurementValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "7bcd43a6-f9c5-4775-b0bb-5b90c661b03d",
          "CreateDate": "2024-11-21T04:57:11.2723384-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T04:57:11.2723384-08:00",
          "LastModifiedUser": "sample string 6"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "0dd64aa2-f512-4e40-92a9-c4250c47c788",
      "CreateDate": "2024-11-21T04:57:11.2723384-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-11-21T04:57:11.2723384-08:00",
      "LastModifiedUser": "sample string 6"
    },
    {
      "TeamId": "b69f7e0e-8593-49f1-8a6a-3b90ffec2f7f",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Users": [],
      "AssetGroups": [
        {
          "AssetGroupId": "b5c28b21-4e38-4010-b887-59da8d220767",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "MeasurementValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "7bcd43a6-f9c5-4775-b0bb-5b90c661b03d",
          "CreateDate": "2024-11-21T04:57:11.2723384-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T04:57:11.2723384-08:00",
          "LastModifiedUser": "sample string 6"
        },
        {
          "AssetGroupId": "b5c28b21-4e38-4010-b887-59da8d220767",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "MeasurementValueNeededDate": "2024-11-21T04:57:11.2723384-08:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "7bcd43a6-f9c5-4775-b0bb-5b90c661b03d",
          "CreateDate": "2024-11-21T04:57:11.2723384-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T04:57:11.2723384-08:00",
          "LastModifiedUser": "sample string 6"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "0dd64aa2-f512-4e40-92a9-c4250c47c788",
      "CreateDate": "2024-11-21T04:57:11.2723384-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-11-21T04:57:11.2723384-08:00",
      "LastModifiedUser": "sample string 6"
    }
  ]
}

Response Information

Resource Description

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

Response Formats

application/json, text/json

Sample:

{
  "Data": {},
  "Total": 1,
  "Message": "sample string 2"
}