Skip To Content
ArcGIS Developers
Dashboard

/createRole: Create Role

  • URL:https://[root]/portals/[portalID]/createRole(POST only)

Example usage

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

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

name=Custom Viewer Role&description=Custom viewer role for your organization&f=pjson

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

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

name=Custom Viewer Role&description=Custom viewer role for your organization&f=pjson

Description

The createRole operation (POST only) creates a new custom role where a more fine-grained set of privileges can be defined with the set role privileges operation. The operation is only available to default organization administrators.

Request parameters

ParameterDetails
name

The name for the custom role. It can contain up to 128 characters.

Example

name=Custom Viewer Role
description

The description for the role. It can be up to 250 characters.

Example

description=Custom viewer role for your organization
f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
success

Indicates if the operation was successful.

id

The ID of the role.

JSON Response syntax

{
  "success": true | false,
  "id": "<role id>"
}

JSON Response example

{
  "success": true,
  "id": "edgebRxFLiLt15df"
}