/settings: Organization Settings

URL:
https://[root]/portals/[portalID]/settings
Methods:
GET
Operations:
Update Organization Settings
Version Introduced:
10.8

Example usage

The following is a sample ArcGIS Online request URL used to access the settings resource:

Use dark colors for code blocksCopy
1
https://org.arcgis.com/sharing/rest/portals/012345678ABCDEF/settings?f=json

The following is a sample ArcGIS Enterprise request URL used to access the settings resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/sharing/rest/portals/012345678ABCDEF/settings?f=json

Description

The 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.

Starting at ArcGIS Enterprise 11.0, this resource will display the customized advanced portal options set using the portalConfigProperties parameter with the Update operation. Previously, administrators who needed to customize their portal's behavior would make updates to the editable version of the portal's configuration file (config.js). For a list of all the properties supported by portalConfigProperties, see Advanced portal configuration properties. These properties are not supported for ArcGIS Online.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

JSON Response example

The following sample JSON response demonstrates information returned by the settings resource for ArcGIS Online and ArcGIS Enterprise (for versions before 11.0) organizations.

Use dark colors for code blocksCopy
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
  "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"
}

For ArcGIS Enterprise organizations at or after version 11.0, the portalConfigProperties property will also be returned in the JSON response:

Use dark colors for code blocksCopy
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
72
73
74
75
76
77
{
  "analysisLayersGroupQuery": "title:\"Living Atlas Analysis Layers\" AND owner:esri_livingatlas",
  "culture": "en",
  "featuredGroups": [
    {
      "owner": "portaladmin",
      "title": "Featured Maps and Apps"
    }
  ],
  "helperServices": {
    "printTask": {"url": "https://machine.domain.com/gis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"},
    "analysis": {"url": "https://machine.domain.com/gis/rest/services/System/SpatialAnalysisTools/GPServer"},
    "asyncGeocode": {"url": "https://machine.domain.com/gis/rest/services/Utilities/GeocodingTools/GPServer"},
    "rasterUtilities": {"url": "https://machine.domain.com/gis/rest/services/Utilities/RasterUtilities/GPServer"},
    "packaging": {"url": "https://machine.domain.com/gis/rest/services/Utilities/OfflinePackaging/GPServer"},
    "symbols": {"url": "https://machine.domain.com/gis/rest/services/Utilities/Symbols/SymbolServer"},
    "geoanalytics": {"url": "https://machine.domain.com/gis/rest/services/System/GeoAnalyticsTools/GPServer"},
    "rasterAnalytics": {"url": "https://machine.domain.com/gis/rest/services/System/RasterAnalysisTools/GPServer"},
    "orthoMapping": {"url": "https://machine.domain.com/gis/rest/services/System/OrthomappingTools/GPServer"},
    "geocode": [
      {
        "url": "https://machine.domain.com/gis/sharing/servers/b6b12fa92bef4e6c9e5c8e73397a44ad/rest/services/World/GeocodeServer",
        "name": "ArcGIS World Geocoding Service",
        "isEsriBatchGeocoder": true,
        "placeholder": "Find address or place",
        "singleLineFieldName": "SingleLine",
        "batch": true,
        "placefinding": true,
        "suggest": true,
        "zoomScale": 10000
      }
    ],
    "route": {"url": "https://machine.domain.com/gis/sharing/servers/89b437a511524660b9ed92f481efa39e/rest/services/World/Route/NAServer/Route_World"},
    "closestFacility": {"url": "https://machine.domain.com/gis/sharing/servers/e65302eb12ce4b399da11d06d84548d1/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World"},
    "asyncClosestFacility": {"url": "https://machine.domain.com/gis/sharing/servers/4fa4a7f212384358b418e9402fd18280/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities"},
    "serviceArea": {"url": "https://machine.domain.com/gis/sharing/servers/e03b31e94d474a84b2d220cf67795cac/rest/services/World/ServiceAreas/NAServer/ServiceArea_World"},
    "asyncServiceArea": {"url": "https://machine.domain.com/gis/sharing/servers/38cc3e101caf4a7d8d6d875936d1b877/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas"},
    "syncVRP": {"url": "https://machine.domain.com/gis/sharing/servers/3880a1e9360b49568fb669524b67b7bb/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem"},
    "asyncVRP": {"url": "https://machine.domain.com/gis/sharing/servers/c94959a0e4b94cc9a76144c3581bb32b/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem"},
    "geoenrichment": {"url": "https://machine.domain.com/gis/sharing/servers/e96632943fb944e89f71d52a58d13e57/rest/services/World/GeoenrichmentServer"},
    "traffic": {"url": "https://machine.domain.com/gis/sharing/servers/19700c9af8944cd2b69e96d8986e0fc4/rest/services/World/Traffic/MapServer"},
    "trafficData": {"url": "https://machine.domain.com/gis/sharing/servers/cd1e3611a5804290bd6943e29892c9b0/rest/services/World/TrafficFeeds/GPServer"},
    "asyncRoute": {"url": "https://machine.domain.com/gis/sharing/servers/538b0aca5f7942e58b6f700660f5e6ff/rest/services/World/Route/GPServer"},
    "asyncODCostMatrix": {"url": "https://machine.domain.com/gis/sharing/servers/025e57ca3bc04573856bc8364b078c89/rest/services/World/OriginDestinationCostMatrix/GPServer"},
    "odCostMatrix": {"url": "https://machine.domain.com/gis/sharing/servers/d9a9e18e016d4b72bc31a11756668410/rest/services/World/OriginDestinationCostMatrix/NAServer/OriginDestinationCostMatrix_World"},
    "asyncLocationAllocation": {"url": "https://machine.domain.com/gis/sharing/servers/57f0f4056a5e4cebab420b8d584047fc/rest/services/World/LocationAllocation/GPServer"},
    "routingUtilities": {"url": "https://machine.domain.com/gis/sharing/servers/25b1dd20b162482ab49474881122375b/rest/services/World/Utilities/GPServer"},
    "elevation": {"url": "https://machine.domain.com/gis/sharing/servers/45de292d672f4bc5a519ad9f6b4e4003/rest/services/Tools/Elevation/GPServer"},
    "elevationSync": {"url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer"},
    "hydrology": {"url": "https://machine.domain.com/gis/sharing/servers/0caffc93e47d45688a4293480310f317/rest/services/Tools/Hydrology/GPServer"},
    "orthomappingElevation": {"url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"}
  },
  "livingAtlasGroupQuery": "title:\"Living Atlas\" AND owner:esri_livingatlas",
  "portalConfigProperties": {
    "extentService": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer",
    "footerLinks": [],
    "gcsBasemapService": "https://wi.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/MapServer",
    "httpsDomains": [
      "arcgis.com",
      "arcgisonline.com",
      "esrikr.com",
      "premiumservices.blackbridge.com",
      "esripremium.accuweather.com",
      "gbm.digitalglobe.com",
      "firstlook.digitalglobe.com",
      "msi.digitalglobe.com"
    ],
    "longTokenExpiration": 20160,
    "searchArcGISOnlineEnabled": true,
    "surveyUrl": "https://survey123.arcgis.com",
    "tokenExpiration": 120,
    "configurePortalAGOEnv": "www.arcgis.com",
    "portalAGOConfigEnabled": true,
    "portalLivingAtlasConfigEnabled": true,
    "iotViewerUrl": "https://velocity.arcgis.com" //Introduced at ArcGIS Enterprise 11.1
  }
}

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