Skip to main content

Delete an User

Used to delete a user

Path Parameters
  • userId int32 required

    Id of the user to delete

Query Parameters
  • skipOwnerShipTransfer boolean

    If user properties needn't be transferred to other user or usergroup

  • transferToUser int32

    If user properties needs to be transferred to other user

  • transfertoUserGroup int32

    If user properties needs to be transferred to other userGroup

Responses

Success


Schema
  • errorMessage string
  • errorCode int32
DELETE /v4/user/:userid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
userId — path required
skipOwnerShipTransfer — query
transferToUser — query
transfertoUserGroup — query
curl -L -X DELETE 'https://localhost/webconsole/api/V4/user/:userId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'