Portal service

The ArcGIS Platform portal is powered by the portal service. The service can create, store, manage, and access different types of content.

Use the portal service to search for different types of public or private content.

Key features

You can use the portal service to:

  • Securely store and access content in the cloud.
  • Store different types of content such as web maps, web scenes, hosted layers, services, app configurations, and files.
  • Manage content properties with items.
  • Search for items.
  • Access content items and content data.
  • Share content with groups of users.
  • Manage users and groups.

How the portal service works

The main operations you can perform with the portal service are:

  • Search: Query to find private and public content.
  • Items: Create, store, manage, and access items.
  • Users: Search for users and manage user content.
  • Groups: Create, search, and manage groups and group content.

Anonymous vs. restricted requests

The portal service can be accessed anonymously to perform some operations, such as searching for public content, while other operations are restricted (private). Examples of restricted operations include accessing private content, creating and sharing content, and performing administration tasks.

To access restricted operations, you must include an access token with the request. The service will grant or deny access to the operation based on the token's credentials.

Learn more about credentials and access tokens in Security and authentication.

Service URL

The base URL for the portal service is:

 
1
https://www.arcgis.com/sharing/rest

Key parameters

f

The format of the data returned. The value can be json, pjson (formatted), or html (not supported by all requests).

token

The access token used to access restricted operations or private content. The value can be an API Key or OAuth 2.0 token.

API keys are limited and do not provide access to restricted operations, but they can be used to access private content such as private feature layers, vector tile layers, image tile layers, web maps, and web scenes. API keys must be scoped to access specific content.

OAuth 2.0 tokens, however, can be used to access restricted operations and all private data types within the scope of the user's credentials.

Learn more about access tokens and authentication methods in Security and authentication.

Examples

Search for an item

Use search to find different types of items.

For more information, see the REST API documentation.

RequestResponse
            
1
2
3
4
5
6
7
8
9
10
11
12
## Public

curl https://www.arcgis.com/sharing/rest/search \
-d 'q=title:"Seven Natural Wonders of the World" AND type:"web map" AND owner:"esri_devlabs"' \
-d 'f=pjson'

## Private

curl https://www.arcgis.com/sharing/rest/search \
-d 'q=title:"Seven Natural Wonders of the World" AND type:"web map" AND owner:"<YOUR_USER_ID>"' \
-d 'f=pjson'
-d 'token=<ACCESS_TOKEN>'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{
  "query": "title:\"Seven Natural Wonders of the World\" AND type:\"web map\" AND owner:\"esri_devlabs\"",
  "total": 1,
  "start": 1,
  "num": 10,
  "nextStart": -1,
  "results": [{
    "id": "5a5147abe878444cbac68dea9f2f64e7",
    "owner": "esri_devlabs",
    "created": 1569537110000,
    "modified": 1569537111000,
    "guid": null,
    "name": null,
    "title": "Seven Natural Wonders of the World Map",
    "type": "Web Map",
    "typeKeywords": [
      "ArcGIS Online",
      "Explorer Web Map",
      "Map",
      "Online Map",
      "Web Map"
    ],
    "description": null,
    "tags": ["map"],
    "snippet": null,
    "thumbnail": "thumbnail/ago_downloaded.png",
    "documentation": null,
    "extent": [
      [
        -180,
        -68.6081
      ],
      [
        180,
        82.5122
      ]
    ],
    "categories": [],
    "spatialReference": null,
    "accessInformation": null,
    "licenseInfo": null,
    "culture": "en-us",
    "properties": null,
    "url": null,
    "proxyFilter": null,
    "access": "public",
    "size": -1,
    "subInfo": 0,
    "appCategories": [],
    "industries": [],
    "languages": [],
    "largeThumbnail": null,
    "banner": null,
    "screenshots": [],
    "listed": false,
    "numComments": 0,
    "numRatings": 0,
    "avgRating": 0,
    "numViews": 6,
    "scoreCompleteness": 33,
    "groupDesignations": null
  }]
}

Access an item

Use items to access an item directly. To do so you need the item ID. You can get the item ID by using ArcGIS Online, the developer dashboard, or building an application to search for items. If the item is private, you need to include an access token.

For more information, see the REST API documentation.

RequestResponse
          
1
2
3
4
5
6
7
8
9
10
## Public

curl https://www.arcgis.com/sharing/rest/content/items/5a5147abe878444cbac68dea9f2f64e7 \
-d 'f=pjson'

## Private

curl https://www.arcgis.com/sharing/rest/content/items/<ITEM_ID> \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Public

{
  "id": "5a5147abe878444cbac68dea9f2f64e7",
  "owner": "esri_devlabs",
  "orgId": "GVgbJbqm8hXASVYi",
  "created": 1569537110000,
  "modified": 1569537111000,
  "guid": null,
  "name": null,
  "title": "Seven Natural Wonders of the World Map",
  "type": "Web Map"
}

// Private

{
  "id": "ITEM_ID",
  "owner": "OWNER",
  "orgId": "ORG_ID",
  "created": "DATE_CREATED",
  "modified": "DATE_MODIFIED",
  "guid": null,
  "name": null,
  "title": "ITEM_TITLE",
  "type": "ITEM_TYPE"
}

Access item data

Use data to return the actual stored content for an item. The type returned depends on the item storage types. To access a private item's data, you need to include an access token in the request along with the item ID.

For more information, see the REST API documentation.

REST API

RequestResponse
          
1
2
3
4
5
6
7
8
9
10
## Public

curl https://www.arcgis.com/sharing/rest/content/items/5a5147abe878444cbac68dea9f2f64e7/data \
-d 'f=pjson'

## Private

curl https://www.arcgis.com/sharing/rest/content/items/<ITEM_ID>/data \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
// Public

{
  "operationalLayers":[
     {
        "id":"Seven_Natural_Wonders_of_the_World_6051",
        "layerType":"ArcGISFeatureLayer",
        "url":"https://services.arcgis.com/uCXeTVveQzP4IIcx/arcgis/rest/services/Seven_Natual_Wonders_of_the_World/FeatureServer/0",
        "visibility":true,
        "opacity":1,
        "title":"Seven Natural Wonders of the World",
        "itemId":"da7cda8d38224b368bc74cc7d6f05d0f"
     }
  ],
  "baseMap":{
     "baseMapLayer":[
        {
           "id":"defaultBasemap",
           "layerType":"ArcGISTiledMapServiceLayer",
           "url":"https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",
           "visibility":true,
           "opacity":1,
           "itle":"Topographic"
        }
     ],
     "title":"Topographic"
  },
  "spatialReference":{
     "wkid":102100,
     "latestWkid":3857
  },
  "authoringApp":"WebMapViewer",
  "authoringAppVersion":"5.4",
  "version":"2.11"
}

// Private

{
   "operationalLayers":[
      {
         "id":"",
         "layerType":"",
         "url": "ITEM_URL"
         "visibility":true,
         "opacity":1,
         "title":"YOUR_ITEM_TITLE",
         "itemId":"ITEM_ID"
      }
   ],
   "baseMap":{
      "baseMapLayer":[
         {
            "id":"defaultBasemap",
            "layerType":"ArcGISTiledMapServiceLayer",
            "url":"https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",
            "visibility":true,
            "opacity":1,
            "itle":"TILE"
         }
      ],
      "title":"BASEMAP_TITLE"
   },
   "spatialReference":{
      "wkid":102100,
      "latestWkid":3857
   },
   "authoringApp":"WebMapViewer",
   "authoringAppVersion":"5.4",
   "version":"2.11"
 }

Create an item

Use addItem (POST) to create an item. At minimum, you need to set the title and type parameters in addition to your access token. You can also upload files to create an item in supported formats like CSV.

For more information, see the REST API documentation.

RequestResponse
       
1
2
3
4
5
6
7
curl https://www.arcgis.com/sharing/rest/content/users/<USER_NAME>/addItem \
-d 'f=pjson' \
-d 'title=World geography' \
-d 'description=This is the map of the world' \
-d 'type=Web map'\
-d 'tags=map, world, geography' \
-d 'token=<ACCESS_TOKEN>'

Response

1
2
3
4
{
  "success": true,
  "id": "ITEM_ID"
}

Update sharing permissions

Use share (POST) as the item owner to edit your item's level of access. The sharing parameters are: everyone (accessible to the public), org, and groups. To perform this call, specify the item ID and set each parameter to a boolean (true or false) and, optionally, the group-id for sharing. When sharing is set to false, your item permissions are set as private.

For more information, visit the REST API documentation.

REST API

RequestResponse
      
1
2
3
4
5
6
curl https://www.arcgis.com/sharing/rest/content/users/<YOUR_ORG>/items/<ITEM_ID>/share \
-d 'everyone=true' \
-d 'org=true' \
-d 'groups=<GROUP_IDs>' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Response

1
2
3
{"results": [{"itemId": "ITEM_ID",
  "success": true,
  "notSharedWith": []}]} // Groups item not shared with

Authentication

To make authenticated requests you need to use one of the following:

  • API key: A permanent token that grants your application access to ready-to-use services and, with an ArcGIS Developer account, private content (currently in beta).
  • ArcGIS Identity (formerly named user): Grants a short-lived token, generated via OAuth 2.0, giving your application permission to access the content and services authorized to an existing ArcGIS user's account.

Learn more about getting access tokens in Security and authentication.

API support

SearchItemsUsersGroups
ArcGIS API for JavaScriptFully supportedFully supportedLimited operationsLimited operations
ArcGIS Runtime API for AndroidFully supportedFully supportedLimited operationsLimited operations
ArcGIS Runtime API for iOSFully supportedFully supportedLimited operationsLimited operations
ArcGIS Runtime API for JavaFully supportedFully supportedLimited operationsLimited operations
ArcGIS Runtime API for .NETFully supportedFully supportedLimited operationsLimited operations
ArcGIS Runtime API for QtFully supportedFully supportedLimited operationsLimited operations
ArcGIS API for PythonFully supportedFully supportedFully supportedFully supported
Esri LeafletRequires ArcGIS REST JSRequires ArcGIS REST JSRequires ArcGIS REST JSRequires ArcGIS REST JS
MapBox GL JSRequires ArcGIS REST JSRequires ArcGIS REST JSRequires ArcGIS REST JSRequires ArcGIS REST JS
OpenLayersRequires ArcGIS REST JSRequires ArcGIS REST JSRequires ArcGIS REST JSRequires ArcGIS REST JS
ArcGIS REST JSFully supportedFully supportedFully supportedFully supported
Full supportPartial support (see notes)Not supported

Tutorials

Use tools to create different types of content and build content-driven applications.

Web maps

Web scenes

Feature layers

Vector tile layers

Basemap layers

Tools

Use tools to access the portal and create and manage content for applications.

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