Skip to content
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://organization.example.com/<context>/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

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
{
  "aiAssistantsEnabled": false, //Added at 12.0
  "analysisLayersGroupQuery": "title:\"Living Atlas Analysis Layers\" AND owner:esri_livingatlas",
  "culture": "en",
  "featuredGroups": [
    {
      "owner": "portaladmin",
      "title": "Featured Maps and Apps"
    }
  ],
  "grantUserAccessToWorkflowManagerServer": true, //Added at 12.0
  "helperServices": {
    "rasterAnalytics": {"url": "https://organization.example.com/gis/rest/services/System/RasterAnalysisTools/GPServer"},
    "rasterUtilities": {"url": "https://organization.example.comgis/rest/services/Utilities/RasterUtilities/GPServer"},
    "geocode": [
      {
        "url": "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer",
        "northLat": "Ymax",
        "southLat": "Ymin",
        "eastLon": "Xmax",
        "westLon": "Xmin",
        "name": "ArcGIS World Geocoding Service",
        "batch": true,
        "placefinding": true,
        "suggest": true
      },
      {
        "url": "https://organization.example.com/gis/sharing/servers/48e2b614886344a187842f2b19140556/rest/services/World/GeocodeServer",
        "northLat": "Ymax",
        "southLat": "Ymin",
        "eastLon": "Xmax",
        "westLon": "Xmin",
        "name": "AGO World Geocoder (CodedUI)",
        "batch": true,
        "placefinding": true,
        "suggest": true,
        "isEsriBatchGeocoder": true,
        "zoomScale": 10000,
        "singleLineFieldName": "SingleLine",
        "placeholder": "Find address or place",
        "username": "GeocodingUnitTest_org",
        "password": "geocode"
      },
      {
        "url": "https://organization.example.com/gis/sharing/servers/48e2b614886344a187842f2b19140556/rest/services/World/GeocodeServer",
        "northLat": "Ymax",
        "southLat": "Ymin",
        "eastLon": "Xmax",
        "westLon": "Xmin",
        "name": "AGO World Geocoder (GeocodingUnitTest_Org)",
        "batch": true,
        "placefinding": true,
        "suggest": true,
        "isEsriBatchGeocoder": true,
        "zoomScale": 10000,
        "singleLineFieldName": "SingleLine",
        "placeholder": "Find address or place",
        "username": "GeocodingUnitTest_org",
        "password": "geocode"
      }
    ],
    "geoenrichment": {"url": "https://organization.example.com/gis/sharing/servers/2f65762ad1c240bd813bc0dd9e8a1864/rest/services/World/GeoenrichmentServer"},
    "elevation": {"url": "https://organization.example.com/gis/sharing/servers/36ee987ff8604e58994a8dda3aa90bb0/rest/services/Tools/Elevation/GPServer"},
    "elevationSync": {"url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer"},
    "hydrology": {"url": "https://organization.example.com/gis/sharing/servers/f20a2d2ceaa1433bae0274bcdf18c6ad/rest/services/Tools/Hydrology/GPServer"},
    "orthomappingElevation": {"url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"},
    "route": {"url": "https://organization.example.com/gis/sharing/servers/c17f59f94a4e41c9a7136f568fe631db/rest/services/World/Route/NAServer/Route_World"},
    "closestFacility": {"url": "https://organization.example.com/gis/sharing/servers/d15442e277054e938df8dc5db6dc69db/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World"},
    "asyncClosestFacility": {"url": "https://organization.example.com/gis/sharing/servers/5f07528919bf42bcbd8cde900513e600/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities"},
    "serviceArea": {"url": "https://organization.example.com/gis/sharing/servers/2e4d6876afae4a348999948ab91545ba/rest/services/World/ServiceAreas/NAServer/ServiceArea_World"},
    "asyncServiceArea": {"url": "https://organization.example.com/gis/sharing/servers/a3f11b8a6d3840bbafcf65da8ee7f30a/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas"},
    "asyncFleetRouting": {"url": "https://organization.example.com/gis/sharing/servers/dc6066b9e59c4e1ba9e83c290026ced5/rest/services/World/VehicleRoutingProblem/GPServer"},
    "snapToRoads": {"url": "https://organization.example.com/gis/sharing/servers/20bb4095e6cc4d5e9e0a92ab9f83a4bb/rest/services/World/SnapToRoadsSync/GPServer"},
    "syncVRP": {"url": "https://organization.example.com/gis/sharing/servers/43cf3675fcf549f9b243e7bbdff570d8/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem"},
    "asyncVRP": {"url": "https://organization.example.com/gis/sharing/servers/78e4600f5715493f8ae3f50ece031f70/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem"},
    "traffic": {"url": "https://organization.example.com/gis/sharing/servers/2ac48d34a7e24c9690d9495e5e09570a/rest/services/World/Traffic/MapServer"},
    "asyncRoute": {"url": "https://organization.example.com/gis/sharing/servers/3b51a8d1480b4e2b9a6c66fb0efb0380/rest/services/World/Route/GPServer"},
    "asyncODCostMatrix": {"url": "https://organization.example.com/gis/sharing/servers/8c7f8d5cdc6846619ac795c843c35f08/rest/services/World/OriginDestinationCostMatrix/GPServer"},
    "odCostMatrix": {"url": "https://organization.example.com/gis/sharing/servers/4c55c06e3f3640dcb7489c03fc47174a/rest/services/World/OriginDestinationCostMatrix/NAServer/OriginDestinationCostMatrix_World"},
    "asyncLocationAllocation": {"url": "https://organization.example.com/gis/sharing/servers/001292e61f1746909201737596fd030e/rest/services/World/LocationAllocation/GPServer"},
    "routingUtilities": {"url": "https://organization.example.com/gis/sharing/servers/a2e7198eda6c4e71be41cc9060cbcc50/rest/services/World/Utilities/GPServer"},
    "routingServicesSource": {
      "sourceName": "ArcGISOnline",
      "agoUsername": "RQASvrPublisher",
      "firstName": "RQA",
      "lastName": "Publisher"
    },
    "geoBIM": {
      "url": "https://organization.example.com/gis/rest/services/GeoBIM/GPServer",
      "authUrl": "https://organization.example.com/gis/rest/services/GeoBIMAuth/GPServer"
    },
    "printTask": {"url": "https://organization.example.com/gis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"},
    "geometry": {"url": "https://organization.example.com/gis/rest/services/Utilities/Geometry/GeometryServer"},
    "analysis": {"url": "https://organization.example.com/gis/rest/services/System/SpatialAnalysisTools/GPServer"},
    "asyncGeocode": {"url": "https://organization.example.com/gis/rest/services/Utilities/GeocodingTools/GPServer"},
    "packaging": {"url": "https://organization.example.com/gis/rest/services/Utilities/OfflinePackaging/GPServer"},
    "symbols": {"url": "https://organization.example.com/gis/rest/services/Utilities/Symbols/SymbolServer"},
    "orthoMapping": {"url": "https://organization.example.com/gis/rest/services/System/OrthomappingTools/GPServer"}
  },
  "livingAtlasGroupQuery": "title:\"Living Atlas\" AND owner:esri_livingatlas",
  "portalConfigProperties": { //returned for ArcGIS Enterprise organizations, starting at ArcGIS Enterprise 11.0
    "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",
    "tpsEnabled": false,
    "dataPipelinesEnabled": false
  }
}

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