Portal service

The portal service is the content management service for a portalArcGIS portal, also known as a portal, is a website with applications and tools that can be used to create, manage, access, and share geospatial content and data. It supports security and authentication, developer credentials, content and data service management, user and group management, and site administration. A portal can be hosted in Esri's infrastructure or your own infrastructure.Learn more. The service can create, store, manage, and access different types of contentContent is a collection of items in a portal that belong to a user, group, or organization.Learn more.

Key features

You can use the portal service to:

• Securely store and access contentContent is a collection of items in a portal that belong to a user, group, or organization.Learn more 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 itemsAn item, also known as a content item, is a resource stored in a portal such as a web map, hosted layer, style, script tool, file, or notebook.Learn more.
• 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 tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more 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 portal service only supports an enhanced endpointAn enhanced endpoint is a URL for an ArcGIS location service hosted in a cloud infrastructure in the United States. They support all service functionality and additional levels of security compliance such as Federal Risk and Authorization Management Program (FedRAMP) and Health Insurance Portability and Accountability Act (HIPAA). Some endpoints also support long transactions.Learn more. The base URL is:

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

Learn more about standardA standard endpoint is a URL for an ArcGIS location service hosted in a global cloud infrastructure. This includes the basemap layer service, and most functionality available in the geocoding service and routing service.Learn more and enhancedAn enhanced endpoint is a URL for an ArcGIS location service hosted in a cloud infrastructure in the United States. They support all service functionality and additional levels of security compliance such as Federal Risk and Authorization Management Program (FedRAMP) and Health Insurance Portability and Accountability Act (HIPAA). Some endpoints also support long transactions.Learn more endpoints in Service endpoints.

Required parameters

Code examples

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>'

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
  }]
}

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>'

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"
}

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>'

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"
 }

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>'

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

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>'

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

Authentication

API support

Pricing

To determine how much it costs to access the portal service:

1. If you have an ArcGIS Location Platform accountAn ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription.Learn more, go to Pricing. Transactions are billed in US dollars. A free tier of transactions may be available.
2. If you have an ArcGIS Online accountAn ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization.Learn more, go to Understand credits. Transactions are billed in creditsCredits are the currency used by ArcGIS Online Organization accounts to account for data storage and location service consumption. Credits are consumed for specific transactions, such as accessing location services, and types of storage, such as storing features, performing analytics, and using premium content.Learn more.

Tutorials

Use tools to create different types of contentContent is a collection of items in a portal that belong to a user, group, or organization.Learn more and build content-driven applications.

Web maps

Style layers in a web map

Use Map Viewer to style layers in a web map.

Map Viewer

Display a web map

Create and display a map from a web map.

JavaScript Maps SDKKotlin Maps SDKSwift Maps SDK.NET Maps SDKJava Maps SDKQt Maps SDKPython API

Web scenes

Style layers in a web scene

Use Scene Viewer to style layers in a web scene.

Scene Viewer

Display a web scene

Create and display a scene from a web scene.

JavaScript Maps SDKKotlin Maps SDKSwift Maps SDK.NET Maps SDKJava Maps SDKQt Maps SDK

Feature layers

Import data to create a feature layer

Use data management tools to import files and create a feature layer in a feature service.

ArcGIS portal

Manage a feature layer

Use a hosted feature layer item to set the properties and settings of a feature layer in a feature service.

ArcGIS portal

Add a feature layer

Access and display point, line, and polygon features from a feature service.

JavaScript Maps SDKKotlin Maps SDKSwift Maps SDK.NET Maps SDKJava Maps SDKQt Maps SDKLeafletMapLibre GL JSOpenLayersCesiumJSPython APIREST JS

Vector tile layers

Create a vector tile service

Use data management tools to create a new vector tile service from a feature service.

ArcGIS portalPython APIREST JS

Add a vector tile layer

Access and display a vector tile layer in a map.

JavaScript Maps SDKLeafletMapLibre GL JSOpenLayers

Basemap layers

Create a custom basemap style

Use the ArcGIS Vector Tile Style Editor to style a vector tile basemap layer.

Vector Tile Style Editor

Display a custom basemap style

Add and display a styled vector tile basemap layer.

JavaScript Maps SDKLeafletMapLibre GL JSOpenLayers

Tools

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