Integration Guides › Web Service API Reference Guide › Valid Web API Objects › user Object › destroy Method (user Object)

destroy Method (user Object)

Description

Destroy a user

Syntax

/api/v1/user/destroy?user=user&vdc=controller-name 

Arguments

user

Username

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Destroy a user named test@CA.com.

GET http://192.168.123.200/api/v1/user/destroy?user=test@3teraCAvdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (user). - Argument user=username missing in the request.

404.1

unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.