- URL:
- https://dataaccess/deleteUserWorkspace
- Methods:
POST- Version Introduced:
- 11.5
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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
}
}