/settings/update: Update Organization Settings

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

1
2
3
4
5
6
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.

Example

1
2
3
4
5
6
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

1
2
3
4
5
6
informationalBanner={
  "text": "Header Text",
  "bgColor": "grey",
  "fontColor": "blue",
  "enabled": true
}

portalConfigProperties

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

Example

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
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,
  "webEditorEnabled": true,
  "configurePortalAGOEnv": "www.arcgis.com",
  "portalAGOConfigEnabled": true,
  "portalLivingAtlasConfigEnabled": true,
  "iotViewerUrl": "https://velocity.arcgis.com"
}

f

The response format. The default response format is html.

Values: html | json | pjson

title

The title of the access notice.

Example

1
"title": "Anonymous Access Notice Title"

text

The text displayed in the access notice.

Example

1
"text": "Authenticated Access Notice Text"

buttons

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

Values: acceptAndDecilne | okOnly

enabled

Specifies whether the access notice is enabled.

Values: true | false

text

The text displayed in the informational banner.

Example

1
"text": "Authenticated Access Notice Text"

bgColor

The background color of the informational banner. This property recognizes common color names (such as red or blue) and hexadecimal color values. While you can choose any color for this property, it is recommended that you choose a color that contrasts appropriately with the fontColor property value, as poor contrast will cause a warning to appear on the Security settings page of your Enterprise portal indicating the insufficient contrast.

Example

1
"bgColor": "grey"

fontColor

The font color of the informational banner. This property recognizes common color names (such as red or blue) and hexadecimal color values. While you can choose any color for this property, it is recommended that you choose a color that contrasts appropriately with the bgColor property value, as poor contrast will cause a warning to appear on the Security settings page of your Enterprise portal indicating the insufficient contrast.

Example

1
"fontColor": "blue"

enabled

Specifies whether the informational banner is enabled.

Values: true | false

extentService

Introduced at ArcGIS Enterprise 11.0. The service that will be used to update, or set the extent of, a web map item. The service must be a tiled map service that uses the WGS84 geographic coordinate system with well-known ID (WKID) 4326.

Example

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

footerLinks

Introduced at ArcGIS Enterprise 11.0. 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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
"footerLinks": [
  {
    title: "Organization",
    url: "http://www.myorganiz.com"
  },
  {
    title: "Terms of Use",
    url: "http://www.myorganiz.com/legal/licensing/termsofuse.html"
  },
  {
    title: "Privacy",
    url: "http://www.myorganiz.com/legal/privacy.html"
  },
  {
    title: "Contact Us",
    email: "feedback@myorganiz.com",
    type: "contactUs"
  },
  {
    title: "Report Abuse",
    email: "feedback@myorganiz.com",
    type: "reportAbuse"
  }
],

gcsBasemapService

Introduced at ArcGIS Enterprise 11.0. The service that will be used as the basemap for OGC WMS services that do not support the Web Mercator coordinate system.

Example

1
2
"gcsBasemapService": "https://wi.maptiles.arcgis.com/arcgis/rest/services/
World_Imagery/MapServer"

httpsDomain

Introduced at ArcGIS Enterprise 11.0. A list of federated servers that Map Viewer Classic can use to switch services from using HTTP to HTTPS.

Example

1
2
3
4
5
6
7
8
9
10
"httpsDomains": [
  "arcgis.com",
  "arcgisonline.com",
  "esrikr.com",
  "premiumservices.blackbridge.com",
  "esripremium.accuweather.com",
  "gbm.digitalglobe.com",
  "firstlook.digitalglobe.com",
  "msi.digitalglobe.com"
]

longTokenExpiration

Introduced at ArcGIS Enterprise 11.0. The expiration time for tokens created when a user selects Keep me signed in when signing in. If Keep me signed in is not selected, the tokenExpiration value overrides the time defined by this property. The default value is 20160 minutes (14 days).

Example

1
"longTokenExpiration": 20160

restrictOrganizationPageToAdmin

Introduced at ArcGIS Enterprise 11.0. Specifies 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 those assigned the default administrator role. The default value is false, which leaves the page visible to all members.

Values: true | false

searchArcGISOnlineEnabled

Introduced at ArcGIS Enterprise 11.0. Specifies whether the option to search for ArcGIS Online layers using both Map Viewer Classic and, starting at ArcGIS Enterprise 11.2, Map Viewer is enabled. When disabled (false), the option to search for ArcGIS Online layers is hidden from the Search for Layers dialog box. The default value is true.

Values: true | false

showCreateDashboard

Introduced at ArcGIS Enterprise 11.0. Specifies whether ArcGIS Dashboards is accessible in the 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 is true.

Values: true | false

showInAppLauncher

Introduced at ArcGIS Enterprise 11.0. A list of Esri applications that display in the app launcher. Entries must be separated by a comma and match the application title expected by ArcGIS Enterprise.

The example below shows the most recent default list of applications. For the list of default applications supported at your deployment's version of ArcGIS Enterprise, reference your Portal Directory API installed help.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
"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 Solutions",
  "Deep Learning Studio",
  "Instant Apps",
  "Scene Viewer",
  "Vector Tile Style Editor"
],

sceneViewerEnabled

Introduced at ArcGIS Enterprise 11.0. Specifies whether Scene Viewer is accessible in the portal. When disabled (false), Scene Viewer options are hidden from all dialog boxes and ribbons in the portal. The default value is true.

Values: true | false

surveyUrl

Introduced at ArcGIS Enterprise 11.0. 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

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

tokenExpiration

Introduced at ArcGIS Enterprise 11.0. The expiration time for tokens generated when a user signs in. If, when signing in, a user selects Keep me signed in, the longTokenExpiration property will override the time set for this property. The default value is 120 minutes (2 hours).

Example

1
"tokenExpiration": 120

webAppBuilderEnabled

Introduced at ArcGIS Enterprise 11.0. Specifies whether ArcGIS Web AppBuilder is accessible to the 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 the portal's Content page. The default value is true.

Values: true | false

configurePortalAGOEnv

Introduced at ArcGIS Enterprise 11.0. The proxy used for configured utility services. For a disconnected environment, set this property to false. The default proxy for non-disconnected environments is shown in the example below.

Example

1
"configurePortalAGOEnv": "www.arcgis.com"

portalAGOConfigEnabled

Introduced at ArcGIS Enterprise 11.0. Specifies whether the ArcGIS Online tab is displayed on the portal's Organization Settings page. If you're configuring a disconnected environment, set this property to false. Before doing so, you must disable access to ArcGIS Living Atlas content. See Configure ArcGIS Living Atlas content. The default value is true.

Values: true | false

portalLivingAtlasConfigEnabled

Introduced at ArcGIS Enterprise 11.0. Specifies whether the Configure Living Atlas Content section will be displayed on the ArcGIS Online tab on the portal's Organization Settings page. In a disconnected environment, set this property to false. Before doing so, you must disable access to ArcGIS Living Atlas content. See Configure ArcGIS Living Atlas content. The default value is true.

Values: true | false

iotViewerUrl

Introduced at ArcGIS Enterprise 11.1. This is the URL to access the ArcGIS Velocity application that can point to an installed ArcGIS Velocity deployment.

Example

1
"iotViewerUrl": "https://velocity.arcgis.com"

webEditorEnabled

Introduced at ArcGIS Enterprise 11.3. Indicates whether the Web Editor setup has been installed. When this property is false, it indicates to the organization and any associated client applications that the Web Editor setup has not been installed and options to open the Web Editor app (ex: App Launcher) are hidden within the Enterprise portal. When the software is installed, this property will be updated to true and options to open the Web Editor will be made visible.

Values: true | false