Skip To Content
ArcGIS Developers
Dashboard

/[roleID]/delete: Delete Role

  • URL:https://[root]/portals/[portalID]/roles/[roleID]/delete(POST only)

Example usage

Below is a sample ArcGIS Online POST request for the delete operation:

POST /sharing/rest/portals/0123456789ABCDEF/roles/2a5MU7lBcBWutf4S/delete HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson

Below is a sample ArcGIS Enterprise POST request for the delete operation:

POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/roles/2a5MU7lBcBWutf4S/delete HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson

Description

The Delete Role operation (POST only) allows default organization administrators to delete a custom role.

Request parameters

ParameterDetails
f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
success

Indicates if the operation was successful.

roleId

The ID of the custom role that got deleted.

JSON Response syntax

{
  "success": true | false,
  "roleId": "<roleId>"
}

JSON Response example

{
  "success": true,
  "roleId": "2a5MU7lBcBWutf4S"
}