Skip To Content
ArcGIS Developer
Dashboard

/settings/update: Update Organization Settings

Example usage

Below is a sample ArcGIS Online POST request for the update operation, formatted for readability:

POST /sharing/rest/portals/0123456789ABCDEF/settings/update HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

anonymousAccessNotice={
  title": "Anonymous Access Notice Title",
  text": "Anonymous Access Notice Text",
  "buttons": "acceptAndDecline",
  "enabled": true
}&authenticatedAccessNotice=authenticatedAccessNotice={
  "title": "Authenticated Access Notice Title",
  "text": "Authenticated Access Notice Text",
  "buttons": "okOnly",
  "enabled":true
}&informationalBanner={
  "text": "Header Text",
  "bgColor": "grey",
  "fontColor": "blue",
  "enabled": true
}&f=pjson

Below is a sample ArcGIS Enterprise POST request for the update operation, formatted for readability. At 11.0, this operation includes the portalConfigProperties parameter:

POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/settings/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

anonymousAccessNotice={
  title": "Anonymous Access Notice Title",
  text": "Anonymous Access Notice Text",
  "buttons": "acceptAndDecline",
  "enabled": true
}&authenticatedAccessNotice=authenticatedAccessNotice={
  "title": "Authenticated Access Notice Title",
  "text": "Authenticated Access Notice Text",
  "buttons": "okOnly",
  "enabled":true
}&informationalBanner={
  "text": "Header Text",
  "bgColor": "grey",
  "fontColor": "blue",
  "enabled": true
}&portalConfigProperties={
  "extentService": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer",
  "footerLinks": [],
  "gcsBasemapService": "https://services.arcgisonline.com/ArcGIS/rest/services/ESRI_Imagery_World_2D/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,
  "restrictOrganizationPageToAdmin": false,
  "searchArcGISOnlineEnabled": true,
  "showCreateDashboard": true,
  "showInAppLauncher": [
    "ArcGIS Dashboards",
    "ArcGIS Enterprise Sites",
    "Track Viewer",
    "Ortho Maker",
    "ArcGIS Workforce",
    "ArcGIS QuickCapture Web Designer",
    "ArcGIS StoryMaps",
    "ArcGIS Experience Builder",
    "ArcGIS Field Maps",
    "ArcGIS Map Viewer",
    "ArcGIS Map Viewer Classic",
    "ArcGIS Dashboards Classic"
  ],
  "sceneViewerEnabled": true,
  "surveyUrl": "https://survey123.arcgis.com",
  "tokenExpiration": 120,
  "webAppBuilderEnabled": true,
  "configurePortalAGOEnv": "www.arcgis.com",
  "portalAGOConfigEnabled": true,
  "portalLivingAtlasConfigEnabled": true
}&f=pjson

Description

The update operation allows you to enable and customize an access notice and informational banner for your organization, as well as set advanced portal settings for your organization. The access notice, for authenticated and anonymous access, acts as a terms of service that users must agree to before being able to access the portal site. The informational banner allows you to alert members of your organization about your site's current status and content, such as a notice that the site is currently in read-only mode or containing content of a specific classification level. For more information, see Configure security settings.

Starting at ArcGIS Enterprise 11.0, this operation also customizes advanced portal options, such as configuring a disconnected deployment, using the portalConfigProperties parameter. 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). Though administrators will no longer need to update the configuration file, it is recommended that a backup of it be made prior to upgrading to a 11.0 deployment in order to preserve the portal's previous customization and settings as a reference. Post-upgrade, the properties defined in the configuration file will need to be manually applied to the portalConfigProperties parameter, as the Sharing API will not automatically harvest and apply the information in the file. For a list of all the properties supported by portalConfigProperties and their default values, see the Advanced portal configuration properties section below.

Note:

The editable version of the portal's configuration file can be found at the following file location for Windows and Linux deployments: <Portal for ArcGIS installation directory>\customizations\<version number>\framework\webapps\arcgis#home\js\arcgisonline\config.js. The original workflow for setting advanced portal settings was only applicable to Windows and Linux deployments; ArcGIS Enterprise on Kubernetes 11.0 supports the portalConfigProperties parameter, as well as establishing disconnected deployments, but older versions of ArcGIS Enterprise on Kubernetes do not have a portal configuration file. This property is not supported for ArcGIS Online.

Request parameters

ParameterDetails
anonymousAccessNotice

A JSON object representing a notice that is shown to your organization's anonymous users. For the required properties for this parameter, see the Access notification properties section below.

Example

anonymousAccessNotice={"title": "Anonymous Access Notice Title","text": "Anonymous Access Notice Text","buttons": "acceptAndDecline","enabled": true}
authenticatedAccessNotice

A JSON object representing a notice that is shown to your organization's authenticated users. For the required properties for this parameter, see the Access notification properties section below.

Note:

Currently, only ArcGIS Online offers support for this authenticatedAccessNotice.

Example

authenticatedAccessNotice={"title": "Authenticated Access Notice Title","text": "Authenticated Access Notice Text","buttons": "okOnly","enabled": true}
informationalBanner

A JSON object representing the informational banner that is shown at the top of your organization's page. For the required properties for this parameter, see the Informational banner properties section below.

Example

informationalBanner={"text": "Header Text","bgColor": "grey","fontColor": "blue","enabled": true}
portalConfigProperties

Introduced at 11.0. A JSON object representing advanced configuration options for your portal. The properties can be used to customize the behavior of the portal to match your organization's needs or to configure a disconnected deployment. For information on the configurable properties, see the Advanced portal configuration properties section below.

Note:

This parameter is supported for ArcGIS Enterprise on Windows and Linux, as well as ArcGIS Enterprise on Kubernetes. This parameter is not supported in ArcGIS Online.

Example, formatted for readability

portalConfigProperties={
  "extentService": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer",
  "footerLinks": [],
  "gcsBasemapService": "https://services.arcgisonline.com/ArcGIS/rest/services/ESRI_Imagery_World_2D/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,
  "restrictOrganizationPageToAdmin": false,
  "searchArcGISOnlineEnabled": true,
  "showCreateDashboard": true,
  "showInAppLauncher": [
    "ArcGIS Dashboards",
    "ArcGIS Enterprise Sites",
    "Track Viewer",
    "Ortho Maker",
    "ArcGIS Workforce",
    "ArcGIS QuickCapture Web Designer",
    "ArcGIS StoryMaps",
    "ArcGIS Experience Builder",
    "ArcGIS Field Maps",
    "ArcGIS Map Viewer",
    "ArcGIS Map Viewer Classic",
    "ArcGIS Dashboards Classic"
  ],
  "sceneViewerEnabled": true,
  "surveyUrl": "https://survey123.arcgis.com",
  "tokenExpiration": 120,
  "webAppBuilderEnabled": true,
  "configurePortalAGOEnv": "www.arcgis.com",
  "portalAGOConfigEnabled": true,
  "portalLivingAtlasConfigEnabled": true
}
f

The response format. The default response format is html.

Values: html | json | pjson

Access notification properties

The table below outlines the properties required by the anonymousAccessNotice and authenticatedAccessNotice parameters.

PropertyDetails
title

Sets the title for the access notice.

Example

"title": "Anonymous Access Notice Title"
text

Sets the text the access notice will display.

Example

"text": "Authenticated Access Notice Text"
buttons

Sets the button option for the access notice. Users will be prompted to select either Accept or Decline, or just OK.

Values: acceptAndDecilne | okOnly

enabled

Determines if the access notice is enabled.

Values: true | false

Information banner properties

The table below outlines the properties required by the informationalBanner parameter.

PropertyDetails
text

Defines the text that the informational banner will display.

Example

"text": "Authenticated Access Notice Text"
bgColor

Specifies the background color for the informational banner. This property recognizes common color names (such as red or blue) and hexadecimal color values. While you are able to choose any color for this property, it is recommended that you choose a color that contrasts appropriately with the fontColor, as a poor contrast will cause a warning to appear in the Security settings page of yourEnterprise portal alerting you to the insufficient contrast.

Example

"bgColor": "grey"
fontColor

Specifies the font color for the for the informational banner. This property recognizes common color names (such as red or blue) and hexadecimal color values. While you are able to choose any color for this property, it is recommended that you choose a color that contrasts appropriately with the bgColor, as a poor contrast will cause a warning to appear in the Security settings page of yourEnterprise portal alerting you to the insufficient contrast.

Example

"fontColor": "blue"
enabled

Determines if the informational banner is enabled.

Values: true | false

Advanced portal configuration properties

The following table outlines the configurable properties for the portalConfigProperties parameter and their default values.

PropertyDetails
extentService

Specifies the service used to update, or set the extent of, a web map item. The service must be a tiled map service that uses the WGS 1984 geographic coordinate system with well-known ID (WKID) 4326.

Example

"extentService": "http://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer"
footerLinks

Defines the user-specified links displayed on all page footers, such as the Terms of Use, Privacy, Contact Us, and Report Abuse links. By default, this property is an empty array.

Example

"footerLinks": []
gcsBasemapService

Sets the service that'll be used as the basemap for OGC WMS services that do not support the Web Mercator coordinate system.

Example

"gcsBasemapService": "https://services.arcgisonline.com/ArcGIS/rest/services/ESRI_Imagery_World_2D/MapServer"
httpsDomain

Lists federated servers that Map Viewer Classic can use to switch services from using HTTP to HTTPS.

Example, formatted for readability

"httpsDomains": [
  "arcgis.com",
  "arcgisonline.com",
  "esrikr.com",
  "premiumservices.blackbridge.com",
  "esripremium.accuweather.com",
  "gbm.digitalglobe.com",
  "firstlook.digitalglobe.com",
  "msi.digitalglobe.com"
]
longTokenExpiration

Sets the expiration time for tokens created when a user selects Keep me signed in upon login. If Keep me signed in is not selected, the tokenExpiration value overrides the time defined by longTokenExpiration. The default time for this property is 20160 minutes (14 days).

Example

"longTokenExpiration": 20160
restrictOrganizationPageToAdmin

Indicates whether the Organization page of the portal is visible to all organization members. If this property is set to true, the Organization page will be hidden from all members expect for those assigned the default administrator role. The default value is false, which leaves the page visible to all members.

Values: true | false

searchArcGISOnlineEnabled

Enables the option to search for ArcGIS Online layers from your portal's Map Viewer Classic. When disabled (false), the option to search for ArcGIS Online layers is hidden from the Search for Layers dialog box. The default value for this property is true.

Values: true | false

showCreateDashboard

Indicates whether ArcGIS Dashboards is accessible in your portal. If disabled (false), Dashboards is hidden from the Share dialog box in Map Viewer Classic, as well as the Create Web App option on the item detail page and the Create App option on the My Content tab of the Content page. The default value for this parameter is true.

Values: true | false

showInAppLauncher

Lists the Esri applications to display in the app launcher. Entries must be separated by a comma.

Example, formatted for readability

"showInAppLauncher": [
  "ArcGIS Dashboards",
  "ArcGIS Enterprise Sites",
  "Track Viewer",
  "Ortho Maker",
  "ArcGIS Workforce",
  "ArcGIS QuickCapture Web Designer",
  "ArcGIS StoryMaps",
  "ArcGIS Experience Builder",
  "ArcGIS Field Maps",
  "ArcGIS Map Viewer",
  "ArcGIS Map Viewer Classic",
  "ArcGIS Dashboards Classic"
]
sceneViewerEnabled

Specifies whether Scene Viewer is accessible in your portal. When disabled (false), Scene Viewer options are hidden from all dialog boxes and ribbons in the portal. The default value for this property is true.

Values: true | false

surveyUrl

Sets the URL used to access the Survey123 website. This URL can point to an installed Survey123 website, including any port numbers or reverse proxy access points.

Example

"surveyUrl": "https://survey123.arcgis.com"
tokenExpiration

Sets the expiration time for tokens generated when a user signs in. If, upon signing in, a user selects Keep me signed in the longTokenExpiration property will override the time set for tokenExpiration. The default expiration time for this property is 120 minutes (2 hours).

Example

"tokenExpiration": 120
webAppBuilderEnabled

Indicates whether ArcGIS Web AppBuilder is accessible to your portal. When disabled (false), Web AppBuilder is hidden from the Share dialog box in Map Viewer Classic, as well as the Create App option on the My Content tab of your portal's Content page. The default value for this property is true.

Values: true | false

configurePortalAGOEnv

Determines the proxy used for configured utility services. For a disconnected environment, this property should be set as false. The default proxy for non-disconnected environments is demonstrated in the example below.

Example

"configurePortalAGOEnv": "www.arcgis.com"
portalAGOConfigEnabled

Controls whether the ArcGIS Online tab is displayed in your portal's Organization Settings page. This property should be set as false if you're configuring a disconnected environment. Before doing so, you'll need to disable access to ArcGIS Living Atlas content. See Configure ArcGIS Living Atlas content. The default value for this property is true.

Values: true | false

portalLivingAtlasConfigEnabled

Controls the display of the Configure Living Atlas Content section within the ArcGIS Online tab in your portal's Organization Settings page. In a disconnected environment this property should be set as false. Before doing so, you'll need to disable access to ArcGIS Living Atlas content. See Configure ArcGIS Living Atlas content. The default value for this property is true.

Values: true | false

JSON Response example

{"success": true}