- 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:
https://org.arcgis.com/sharing/rest/portals/012345678ABCDEF/settings?f=jsonThe following is a sample ArcGIS Enterprise request URL used to access the settings resource:
https://organization.example.com/<context>/sharing/rest/portals/012345678ABCDEF/settings?f=jsonDescription
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 portal 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 portal, see Advanced portal configuration properties. These properties are not supported for ArcGIS Online.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
JSON Response example
{
"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
}
}