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
NameDescriptionTypeAdditional 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.

Profiles

Collection of Profile

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "ba67e0fd-580b-42a4-9a7c-b3690742da8b",
  "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": "c21f7c88-c13d-4c74-ad25-799aa7df9d97",
  "Profiles": [
    {
      "ProfileId": "e5d52c2b-643f-47c9-b32d-b21d0fcb718e",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Users": [],
      "AssetGroups": [
        {
          "AssetGroupId": "a32841a3-c1d9-418f-81fe-30c2a157315c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "b2b8d75a-014c-4e39-bc3b-b15a2869e96c",
          "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        },
        {
          "AssetGroupId": "a32841a3-c1d9-418f-81fe-30c2a157315c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "b2b8d75a-014c-4e39-bc3b-b15a2869e96c",
          "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "5d0d8451-2391-4e0b-84fe-5bcb5f06859b",
      "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
      "CreateUser": "sample string 5",
      "CreateMachine": "sample string 6",
      "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
      "LastModifiedUser": "sample string 7",
      "LastModifiedMachine": "sample string 8"
    },
    {
      "ProfileId": "e5d52c2b-643f-47c9-b32d-b21d0fcb718e",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Users": [],
      "AssetGroups": [
        {
          "AssetGroupId": "a32841a3-c1d9-418f-81fe-30c2a157315c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "b2b8d75a-014c-4e39-bc3b-b15a2869e96c",
          "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        },
        {
          "AssetGroupId": "a32841a3-c1d9-418f-81fe-30c2a157315c",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "ParentGroup": null,
          "DisplayOrder": 1,
          "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
          "SourceSystemId": "sample string 3",
          "CompanyId": "b2b8d75a-014c-4e39-bc3b-b15a2869e96c",
          "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
          "LastModifiedUser": "sample string 7",
          "LastModifiedMachine": "sample string 8"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "5d0d8451-2391-4e0b-84fe-5bcb5f06859b",
      "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
      "CreateUser": "sample string 5",
      "CreateMachine": "sample string 6",
      "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
      "LastModifiedUser": "sample string 7",
      "LastModifiedMachine": "sample string 8"
    }
  ]
}

Response Information

Resource Description

On success, the deleted user.

NameDescriptionTypeAdditional information
Data

User

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "UserId": "817dfcd2-8eb0-4ecb-99b5-6809c30ad756",
    "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": "6e95f813-e591-48d5-b67f-585bcfefbc85",
    "Profiles": [
      {
        "ProfileId": "a091c7ef-197e-4028-bc7f-933bbd082b09",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Users": [],
        "AssetGroups": [
          {
            "AssetGroupId": "701e16d5-24ef-4dac-b6fa-8ca303cf2422",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "7e1c9985-e247-476e-a736-fccb0a7cea7b",
            "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          },
          {
            "AssetGroupId": "701e16d5-24ef-4dac-b6fa-8ca303cf2422",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "7e1c9985-e247-476e-a736-fccb0a7cea7b",
            "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          }
        ],
        "SourceSystemId": "sample string 3",
        "CompanyId": "efa72ee7-299a-42d7-9d85-b2be5f1546d4",
        "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
        "CreateUser": "sample string 5",
        "CreateMachine": "sample string 6",
        "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
        "LastModifiedUser": "sample string 7",
        "LastModifiedMachine": "sample string 8"
      },
      {
        "ProfileId": "a091c7ef-197e-4028-bc7f-933bbd082b09",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Users": [],
        "AssetGroups": [
          {
            "AssetGroupId": "701e16d5-24ef-4dac-b6fa-8ca303cf2422",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "7e1c9985-e247-476e-a736-fccb0a7cea7b",
            "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          },
          {
            "AssetGroupId": "701e16d5-24ef-4dac-b6fa-8ca303cf2422",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "ParentGroup": null,
            "DisplayOrder": 1,
            "FormValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "MeasurementValueNeededDate": "2021-04-17T06:30:56.7947915-07:00",
            "SourceSystemId": "sample string 3",
            "CompanyId": "7e1c9985-e247-476e-a736-fccb0a7cea7b",
            "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          }
        ],
        "SourceSystemId": "sample string 3",
        "CompanyId": "efa72ee7-299a-42d7-9d85-b2be5f1546d4",
        "CreateDate": "2021-04-17T06:30:56.7947915-07:00",
        "CreateUser": "sample string 5",
        "CreateMachine": "sample string 6",
        "LastModifiedDate": "2021-04-17T06:30:56.7947915-07:00",
        "LastModifiedUser": "sample string 7",
        "LastModifiedMachine": "sample string 8"
      }
    ]
  },
  "Total": 1,
  "Message": "sample string 1"
}