/createRole: Create Role

URL:
https://[root]/portals/[portalID]/createRole
Methods:
POST

Example usage

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
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

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
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 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 members assigned the default administrator role.

Request parameters

ParameterDetails

name

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

Example

Use dark colors for code blocksCopy
1
name=Custom Viewer Role

description

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

Example

Use dark colors for code blocksCopy
1
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

Use dark colors for code blocksCopy
1
2
3
4
{
  "success": true | false,
  "id": "<role id>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "success": true,
  "id": "edgebRxFLiLt15df"
}

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