Skip To Content ArcGIS for Developers Sign In Dashboard

Organization Settings

Description

The portal settings resource is used to return a view of the portal's configuration as seen by the current users, either anonymous or logged in. Information returned by this resource includes helper services, allowed redirect URIs, and the current configuration for any access notices or information banners.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL for the settings resource:

https://machine.domain.com/webadaptor/sharing/rest/portals/012345678ABCDEF/settings?f=json

JSON Response example

{
  "allowedRedirectUris": [],  "helperServices": {
    "geoanalytics": {"url": "https://machine.domain.com/webadaptor/rest/services/System/GeoAnalyticsTools/GPServer"},
    "printTask": {
      "url": "https://machine.domain.com/webadaptor/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task",
      "templates": [
        {
          "label": "MAP_ONLY",
          "format": "PNG32",
          "layout": "MAP_ONLY"
        },
        {
          "label": "A3 Landscape",
          "format": "PNG32",
          "layout": "A3 Landscape",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "A3 Portrait",
          "format": "PNG32",
          "layout": "A3 Portrait",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "A4 Landscape",
          "format": "PNG32",
          "layout": "A4 Landscape",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "A4 Portrait",
          "format": "PNG32",
          "layout": "A4 Portrait",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "Letter ANSI A Landscape",
          "format": "PNG32",
          "layout": "Letter ANSI A Landscape",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "Letter ANSI A Portrait",
          "format": "PNG32",
          "layout": "Letter ANSI A Portrait",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "Tabloid ANSI B Landscape",
          "format": "PNG32",
          "layout": "Tabloid ANSI B Landscape",
          "layoutOptions": {"legend": false}
        },
        {
          "label": "Tabloid ANSI B Portrait",
          "format": "PNG32",
          "layout": "Tabloid ANSI B Portrait",
          "layoutOptions": {"legend": false}
        }
      ]
    },
    "analysis": {"url": "https://machine.domain.com/webadaptor/rest/services/System/SpatialAnalysisTools/GPServer"},
    "asyncGeocode": {"url": "https://machine.domain.com/webadaptor/rest/services/Utilities/GeocodingTools/GPServer"},
    "rasterUtilities": {"url": "https://machine.domain.com/webadaptor/rest/services/Utilities/RasterUtilities/GPServer"},
    "packaging": {"url": "https://machine.domain.com/webadaptor/rest/services/Utilities/OfflinePackaging/GPServer"},
    "geocode": [
      {
        "url": "http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer",
        "northLat": "Ymax",
        "southLat": "Ymin",
        "eastLon": "Xmax",
        "westLon": "Xmin",
        "name": "ArcGIS World Geocoding Service",
        "batch": false,
        "placefinding": true,
        "suggest": true
      },
      {
        "url": "https://machine.domain.com/webadaptor/sharing/servers/b27f4b69892b4e6a80447dbb2ecdb0c1/rest/services/World/GeocodeServer",
        "name": "Esri World Batch Geocoder",
        "isEsriBatchGeocoder": true,
        "placeholder": "Find address or place",
        "singleLineFieldName": "SingleLine",
        "batch": true,
        "placefinding": true,
        "suggest": true,
        "zoomScale": 10000
      }
    ],
    "route": {"url": "https://machine.domain.com/webadaptor/sharing/servers/a76d029529c54bde88685a1b5c96b78c/rest/services/World/Route/NAServer/Route_World"},
    "closestFacility": {"url": "https://machine.domain.com/webadaptor/sharing/servers/421a15a78ac148e8914b68e0d0635e75/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World"},
    "asyncClosestFacility": {"url": "https://machine.domain.com/webadaptor/sharing/servers/392214c475c94741b2aa16f3e48fe666/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities"},
    "serviceArea": {"url": "https://machine.domain.com/webadaptor/sharing/servers/d1333d1279fa4ea0a0c43d1172b4d9b6/rest/services/World/ServiceAreas/NAServer/ServiceArea_World"},
    "asyncServiceArea": {"url": "https://machine.domain.com/webadaptor/sharing/servers/e90a5900ca6b4fca9d1d037880d30084/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas"},
    "syncVRP": {"url": "https://machine.domain.com/webadaptor/sharing/servers/f2f20ca4b9164849bfad76f63eeb9895/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem"},
    "asyncVRP": {"url": "https://machine.domain.com/webadaptor/sharing/servers/5c617347d534417eb07cfc0d1dbd6c81/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem"},
    "geoenrichment": {"url": "https://machine.domain.com/webadaptor/sharing/servers/55556c4432194b4080227627cc7773bc/rest/services/World/GeoenrichmentServer"},
    "traffic": {"url": "https://machine.domain.com/webadaptor/sharing/servers/c2537af3808f480a92e8290bd368bd9b/rest/services/World/Traffic/MapServer"},
    "asyncRoute": {"url": "https://machine.domain.com/webadaptor/sharing/servers/3b1e8dbf51dd4e3087d92d753657d4bf/rest/services/World/Route/GPServer"},
    "asyncODCostMatrix": {"url": "https://machine.domain.com/webadaptor/sharing/servers/1035fa78118c495b937a0c360830a26a/rest/services/World/OriginDestinationCostMatrix/GPServer"},
    "asyncLocationAllocation": {"url": "https://machine.domain.com/webadaptor/sharing/servers/00435065c2d94a7dafabd294e32cf88b/rest/services/World/LocationAllocation/GPServer"},
    "routingUtilities": {"url": "https://machine.domain.com/webadaptor/sharing/servers/dcb347384df94f6db0d947478a9f32c0/rest/services/World/Utilities/GPServer"},
    "elevation": {"url": "https://machine.domain.com/webadaptor/sharing/servers/207e9dc64b48444fbd646d9347cc7b97/rest/services/Tools/Elevation/GPServer"},
    "elevationSync": {"url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer"},
    "hydrology": {"url": "https://machine.domain.com/webadaptor/sharing/servers/6f3ed9326038483c998f4ab80cffef49/rest/services/Tools/Hydrology/GPServer"},
    "orthomappingElevation": {"url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"},
    "geometry": {"url": "https://utility.arcgisonline.com/webadaptor/rest/services/Geometry/GeometryServer"},
    "defaultElevationLayers": [{
      "url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer",
      "id": "globalElevation",
      "layerType": "ArcGISTiledElevationServiceLayer",
      "name": "Terrain3D"
    }]
  },
  "anonymousAccessNotice": {
    "title": "Anonymous Access Notice Title",
    "text": "Anonymous Access Notice Text",
    "bgColorTitle": "red",
    "fontColorTitle": "white"
  },
  "authenticatedAccessNotice": {
    "title": "Anonymous Access Notice Title",
    "text": "Anonymous Access Notice Text",
    "bgColorTitle": "red",
    "fontColorTitle": "white"
  },
  "culture": "en",
  "featuredGroups": [{
    "owner": "admin",
    "title": "Featured Maps and Apps"
  }],
  "helperServices": {
    "printTask": {
      "templates": [{
        "layout": "MAP_ONLY",
        "format": "PNG32",
        "label": "Map Only"
      }],
      "url": "https://machine.domain.com/webadaptor/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
    },
    "analysis": {"url": "https://machine.domain.com/webadaptor/rest/services/System/SpatialAnalysisTools/GPServer"},
    "asyncGeocode": {"url": "https://machine.domain.com/webadaptor/rest/services/Utilities/GeocodingTools/GPServer"},
    "rasterUtilities": {"url": "https://machine.domain.com/webadaptor/rest/services/Utilities/RasterUtilities/GPServer"},
    "packaging": {"url": "https://machine.domain.com/webadaptor/rest/services/Utilities/OfflinePackaging/GPServer"}
  },
  "informationalBanner": {
    "title": "Informational Banner",
    "text": "Header Text",
    "bgColor": "red",
    "fontColor": "blue"
  },
  "livingAtlasGroupQuery": "title:\"Living Atlas\" AND owner:esri_livingatlas"
}