DELETE v1/users({UserId})

Disable a User for a Company

Information:

Use this request to disable a user completely.

Note that you cannot completely delete a user record. “Deleting” a user record disables the user, setting the IsActive property to false. (Note that this is the only way to set IsActive to false; this property cannot be set directly.) When disabled, the user will no longer be able to log on to the system and the user is not returned in searches (except searches for disabled users).

Note: Disabling a user does NOT free up the user's email address or username for use by another user.

To free up an email address or username, you must PUT an update to the user record. Use the update request to change email or username of the original user to something else.

Base URL:

https://api.covasoft.net/usermanager

Example of a call would be:

https://api.covasoft.net/usermanager/v1/users({UserId})

Request Information

URI Parameters

Name	Description	Type	Additional information
UserId	The User Id you want to Disable	integer	Required

Body Parameters

None.

Response Information

Resource Description

The Disabled User Details

DisableAUserReturn

Name	Type	Additional information
Id	integer	None.
CorrelationId	string	None.
ClientUserId	string	None.
FirstName	string	None.
LastName	string	None.
UserName	string	None.
Email	string	None.
IsActive	boolean	None.
ParentEntityId	integer	None.
ParentEntityName	string	None.
Profiles	Collection of Object	None.
Picture	UserPicture	None.
Address	UserAddress	None.
PhoneNumbers	Collection of UserPhoneNumber	None.
JobTitle	string	None.
Attributes	UserAttributes	None.
Version	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CorrelationId": "sample string 2",
  "ClientUserId": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "UserName": "sample string 6",
  "Email": "sample string 7",
  "IsActive": true,
  "ParentEntityId": 9,
  "ParentEntityName": "sample string 10",
  "Profiles": [
    {},
    {}
  ],
  "Picture": {
    "Id": "8e1c55c0-63f4-4a16-acc1-562e8bdfd6fa",
    "Href": "http://webapihelppage2.com",
    "Height": 1.1,
    "Width": 1.1,
    "Md5Checksum": "sample string 3",
    "Name": "sample string 4",
    "MimeType": "sample string 5"
  },
  "Address": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "City": "sample string 3",
    "StateCode": "sample string 4",
    "CountryCode": "sample string 5",
    "Zip": "sample string 6"
  },
  "PhoneNumbers": [
    {
      "Number": "sample string 1",
      "Extension": "sample string 2",
      "Type": "sample string 3"
    },
    {
      "Number": "sample string 1",
      "Extension": "sample string 2",
      "Type": "sample string 3"
    }
  ],
  "JobTitle": "sample string 11",
  "Attributes": {
    "Department": "sample string 1",
    "BadgeId": 2
  },
  "Version": 12
}