Delete User Workspace

URL:
https://<root>/dataaccess/<workspacename>/deleteUserWorkspace
Methods:
POST
Required Capability:
Administrator
Version Introduced:
11.4

Description

The deleteUserWorkspaces operation enables an administrator to remove a user's workspace directory permanently.

Request parameters

ParameterDetails

userName

The userName of the user whose notebook workspace directory is being deleted.

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Below is a sample request URL and parameters for the deleteUserWorkspaces operation:

Use dark colors for code blocksCopy
1
2
3
4
HTTP POST
https://notebookserver.domain.com/arcgis/admin/dataaccess/deleteUserWorkspace
userName=gis_joe
f=json

JSON Response syntax

Use dark colors for code blocksCopy
1
{"status": "<success | failure>"}

JSON Response example

Example 1:

Use dark colors for code blocksCopy
1
{"status":"success"}

Example 2 - Error when source user has one or more active containers:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "error" : {
    "code" : 500,
    "message" : "Failed to delete user workspace. The user has actively running containers.",
    "details" : null
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.