- URL:https://[root]/portals/[portalID]
Example usage
Below is a sample ArcGIS Online request URL used to access the portal resource:
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF?f=pjsonBelow is a sample ArcGIS Enterprise request URL used to access the portal resource:
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF?f=pjsonDescription
Portal returns information on your organization and is accessible to administrators. Publishers and information workers can view users and resources of the organization.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default format is html. Values: html | json | pjson |
Response properties
| Property | Details |
|---|---|
| portal properties | See Portal Self for details. |
JSON Response syntax
{
"access": private | public,
"allSSL": false | true,
"backgroundImage": "default_image" | "custom_image" | "none"
"basemapGalleryGroupQuery": "title:\"<group name>\" AND owner:<username>",
"bingKey": "<bing key>",
"canSearchPublic": true | false,
"canSearchBingPublic": true | false,
"canSharePublic": true | false,
"canSignInArcGIS": true | false,
"canSignInIDP": true | false,
"colorSetsGroupQuery": "title:\"<group name>\" AND owner:<username>",
"commentsEnabled": "true | false",
"created": date created shown in UNIX time,
"culture": "<culture code>"
"customBaseUrl": "<URL>",
"databaseQuota": <database quota - bytes>,
"databaseUsage": <database used - bytes>,
"defaultBasemap": {
"baseMapLayers": [
{
"url": "<map service URL>",
}
],
"title": "<title of basemap>"
},
"defaultExtent": {
"xmin": <x min>,
"ymin": <y min>,
"xmax": <x max>,
"ymax": <y max>,
"spatialReference": {"wkid": <well-known id> | "wkt": <well-known text string> }
},
"description": "description and/or image",
"featuredGroups": [ //1,2,3,...n
{
"owner": "<username1>",
"title": "<group name1>"
},
{
"owner": "<username2>",
"title": "<group name2>"
},
{
"owner": "<username3>",
"title": "<group name3>"
}
],
"featuredItemsGroupQuery": "id:<"featured group id | null>",
"helperServices": {
"geocode": [
{
"url": "<URL to Geocoding Service>",
"northLat": "Ymax",
"southLat": "Ymin",
"eastLon": "Xmax",
"westLon": "Xmin"
}
],
"geometry": {"url": "<URL to Geometry Service>"},
"printTask": {"url": "<URL to Print Service>"},
"route": {"url": "<URL to Network Analysis Service>"},
"closestFacility": {"url": "<URL to Network Analysis Service>"},
"asyncClosestFacility": {"url": "<URL to Network Analysis Service>"},
"traffic": {"url": "<URL to Traffic Map Service>"},
"serviceArea":{"url": "<URL to Network Analysis Service>"},
"asyncServiceArea": {"url": "<URL to Network Analysis Service>"},
"syncVRP": {"url": "<URL to Network Analysis Service>"},
"asyncVRP": {"url": "<URL to Network Analysis Service>"},
"analysis": {"url": "<URL to Hosted GP Service>"},
"geoenrichment": {"url": "<URL to Geoenrichment Service>"}
},
"homePageFeaturedContent": "title:\"<group name>\" AND owner:<username>",
"homePageFeaturedContentCount":
"id": "<organization id>",
"isPortal": true | false,
"layerTemplatesGroupQuery": "title:\"<group name>\" AND owner:<username>",
"maxTokenExpirationMinutes": <-1 is default; for ArcGIS online - 2 weeks, OAuth refresh tokens -unlimited; OAuth access tokens - 2 weeks>,
"modified": date modified shown in UNIX time
"name": "<organization name>",
"portalHostname": "<URL>",
"portalMode": "singletenant" | multitenant"}
"portalName": "<name of portal>",
"portalThumbnail": file name,
"region": "<region>",
"rotatorPanels": [
{
"id": "banner",
"innerHTML": "<custom HTLM>"
}
],
"showHomePageDescription": true | false
"storageQuota": <storage quota - bytes>,
"storageUsage": <storage used - bytes>,
"supportsHostedServices": true | false,
"symbolSetsGroupQuery": "title:\"<group name>\" AND owner:<username>",
"templatesGroupQuery": "title:\"<group name>\" AND owner:<username>",
"thumbnail": "<file name>",
"urlKey": null,
"useStandardizedQuery": true | false,
"httpPort": <port number>,
"httpsPort": <port number>,
"ipCntryCode": "<country code>",
"supportsOAuth": true | false,
"user": {
"username": "<username>",
"fullName": "<first name> <last name>",
"preferredView": "Web | GIS | null",
"description": "<description>",
"email": "<email address>",
"access": private | org | public,
"storageUsage": <storage used - bytes>,
"storageQuota": <storage quota - bytes>,
"org id": "<organization id>",
"role": <org_admin | org_publisher | org_user>,
"tags": [
"<tag1>",
"<tag2>"
],
"culture": "<culture code>",
"region": "<region>",
"thumbnail": "<file name>",
"created": date created shown in UNIX time,
"modified": date modified shown in UNIX time,
},
"appInfo": {
"appId": "<registered app id>",
"itemId": "<item id of the app>",
"appOwner": "<the app owner>",
"orgId": "<the org that the app owner is a member of>",
"appTitle": "<the app title>"
}
}JSON Response example
{
"access": public,
"allSSL": false,
"backgroundImage": "background.jpg",
"basemapGalleryGroupQuery": "title:\"Cloud Creek Basemaps\" AND owner:jsmith",
"bingKey": "AqkbwzQqrTdyyfyxDGDr8BtKFOYkrK1EhSEOQLSWfKOO1ukAJGbFjxwqbK2sd4cx",
"canSearchPublic": true,
"canShareBingPublic": false,
"canSharePublic": true,
"canSignInArcGIS": false,
"canSignInIDP": false,
"colorSetsGroupQuery": "title:\"Esri Colors\" AND owner:esri_en",
"commentsEnabled": false,
"created":1308083325000,
"culture": "en-EN",
"customBaseUrl": "maps.arcgis.com",
"databaseQuota": 1073741824,
"databaseUsage": 257727488,
"defaultBasemap": {
"baseMapLayers": [
{
"url": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer"
}
],
"title": "World Topo Map"
},
"defaultExtent": {
"xmin": -1.392255164E7,
"ymin": 2819293.2,
"xmax": -7435799.67,
"ymax": 6292591.76,
"spatialReference": {"wkid": 102100}
},
"description": "Welcome to the City of Cloud Creek",
"featuredGroups": [
{
"owner": "esri",
"title": "Esri Maps and Data"
},
{
"owner": "esri",
"title": "Federal_User_Community"
},
{
"owner": "esri",
"title": "Landsat Community"
}
],
"featuredItemsGroupQuery": "id:dd262e10ac1b48d3b4eb44a8ea35f078",
"helperServices": {
"geocode": [
{
"url": "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer",
"northLat": "Ymax",
"southLat": "Ymin",
"eastLon": "Xmax",
"westLon": "Xmin"
}
],
"geometry": {"url": "https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer"},
"printTask": {"url": "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"},
"route": {"url": "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer"},
"closestFacility": {"url": "https://route.arcgis.com/arcgis/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World"},
"asyncClosestFacility": {"url": "https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities"},
"traffic": {"url": "https://traffic.arcgis.com/arcgis/rest/services/World/Traffic/MapServer"},
"serviceArea": {"url": "https://route.arcgis.com/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World"},
"asyncServiceArea": {"url": "https://logistics.arcgis.com/arcgis/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas"},
"syncVRP": {"url": "https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem"},
"asyncVRP": {"url": "https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem"},
"analysis": {"url": "https://analysis.arcgis.com/arcgis/rest/services/tasks/GPServer"},
"geoenrichment": {"url": "https://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer"}
},
"homePageFeaturedContent": "title:\"Home Featured Content\" AND owner:jsmith",
"homePageFeaturedContentCount": 12,
"id": "98c8310359774117a4f3cb6d36b507b2",
"isPortal": false,
"layerTemplatesGroupQuery": "title:\"Esri Layer Templates\" AND owner:esri_en",
"maxTokenExpirationMinutes": -1,
"modified": 1308083325000,
"name": "City of Cloud Creek",
"portalHostname": "www.arcgis.com",
"portalMode": "multitenant",
"portalName": "ArcGIS Online",
"portalThumbnail": home.jpg,
"region": "US",
"rotatorPanels": [
{
"id": "banner-2",
"innerHTML":"<img src='images/banner-2.jpg' style='-webkit-border-radius:0 0 10px 10px;
-moz-border-radius:0 0 10px 10px; -o-border-radius:0 0 10px 10px; border-radius:0 0 10px 10px; margin-top:0;
width:960px; height:180px;'/><div style='position:absolute; bottom:80px; left:80px; max-height:65px; width:660px;
margin:0;'><img src='https://cloudcreek.maps.arcgis.com/sharing/rest/portals/self/resources/thumbnail.jpg?
token=SECURITY_TOKEN' alt='City of Cloud Creek' style='float:left; margin-right:20px; margin-bottom:0;
max-height:100px;'/><span style='position:absolute; bottom:0; margin-bottom:0; line-height:normal;
font-family:HelveticaNeue,Verdana; font-weight:600; font-size:32px; color:#369;'>City of Cloud Creek<\/span><\/div>"
}
],
"showHomePageDescription": true,
"storageQuota": 107374182400,
"storageUsage": 491717310,
"supportsHostedServices": true,
"symbolSetsGroupQuery": "title:\"Esri Symbols\" AND owner:esri_en",
"templatesGroupQuery": "title:\"Web Application Templates\" AND owner:esri_webapi",
"thumbnail": "thumbnail.jpg",
"urlKey": cloudcreek,
"useStandizedQuery": true,
"httpPort": 80,
"httpsPort": 443,
"ipCntryCode": "US",
"supportsOAuth": true,
"user": {
"username": "jsmith",
"fullName": "John Smith",
"preferredView": "Web",
"description": "Senior GIS Analyst for the city of Redlands.",
"email": "jsmith@esri.com",
"access": "public",
"storageUsage": 583650,
"storageQuota": 2147483648,
"orgId": "98c8310359774117a4f3cb6d36b507b2",
"role": "org_admin",
"tags": [
"<GIS Analyst>",
"<City of Redlands>"
],
"culture": "en",
"region": "US",
"thumbnail": "<myProfile.jpg>",
"created": 1258501046000,
"modified": 1290625562000
},
"appInfo": {
"appId": "GR2ksyoodj0Hksb8",
"itemId": "5165d9cf09ac4ca086c995437b01a950",
"appOwner": "jsmith",
"orgId": "5uh3wwYLNzBuU0Eu",
"appTitle": "Find your Bike Route"
}
}