- URL:
- https://dataaccess/deleteUserWorkspace
- Methods:
POST- Required Capability:
- Access allowed only with the default administrator role
- Version Introduced:
- 11.5
Description
The delete operation enables an administrator to remove a user's workspace directory permanently. This operation can only be performed if the user does not have any active containers.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The username of the user whose notebook workspace directory is being deleted. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the delete operation:
POST /<context>/notebooks/admin/dataaccess/deleteUserWorkspace HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
userName=gis_joe&f=pjson&token=PuuxoDV8HzHD1GxXUDpgHDeItErtl9Wr6rbULdhXHVUnGsjZ2hI1j1cPmnDEN1UnUfDqrNr2AuviTe5OkBumXsPlwSCrKw_ZVM1vczv2ziRESyz2PEAAhfsf71EyKIEGe7wW1z7hN_aLIjTekcdUbs-xtUAMZjEKHDRxT85NlfWqQghOy6o5XE54P8nnmdhllY6IfdtqeRtOYfFLoCBGCmOFV8diNVk4CxW3MMnzelDAGuRpN-Bru-vcYTY-7Or9JSON Response syntax
{"status": "<success | failure>"}JSON Response examples
The sample response below demonstrates a success response returned by the operation:
{"status":"success"}The sample response below demonstreates an error message that is returned when attempting to delete the user workspace when the user has actively running contianers:
{
"error" : {
"code" : 500,
"message" : "Failed to delete user workspace. The user has actively running containers.",
"details" : null
}
}