- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- User tasks
User delete
Function
The UserDelete task deletes a user.
A user can be deleted only if there are no objects (domains, zones, ...) for this user. Also the main user cannot be deleted.
Description
Route: DELETE /user/{name}/{context}
{
}{
"stid": "20211102-test-9495",
"status": {
"code": "S1301003",
"text": "User was successfully deleted.",
"type": "SUCCESS"
},
"object": {
"type": "User",
"value": "subuser-1, 4"
}
}
Task code: 1301003
Uses User object
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>1301003</code>
<user>
<user>customersub1</user>
<context>4</context>
</user>
</task>
</request><response>
<result>
<data />
<status>
<code>S1301003</code>
<text>User was successfully deleted.</text>
<type>success</type>
<object>
<type>user</type>
<value>customersub1, 4</value>
</object>
</status>
</result>
<stid>20211102-test-9458</stid>
</response>