Skip To Content ArcGIS for Developers Sign In Dashboard

Update Organization Settings

Description

This operation allows you to enable and customize an access notice and informational banner 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.

Request parameters

ParameterDetails
anonymousAccessNotice

A JSON object representing a notice that is shown to your organization's anonymous users.

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.

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.

Example

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

The response format. The default response format is html.

Values: html | json | pjson

JSON Object properties

ParameterDetails
title

The title for the access notice. This property is required by the anonymousAccessNotice and authenticatedAccessNotice parameters.

Example

"title": "Anonymous Access Notice Title"
text

The text the access notice will display. This property is required by the anonymousAccessNotice, authenticatedAccessNotice, and informationalBanner parameters.

Example

"text": "Authenticated Access Notice Text"
buttons

Sets the button option for the access notice. Users will either prompted to select Accept or Decline, or just OK. This property is required by the anonymousAccessNotice and authenticatedAccessNotice parameters.

Values: acceptAndDecilne | okOnly

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 property. A warning will appear in the Enterprise portal in the Security settings alerting you to insufficient contrast between the two properties. This property is required by the informationalBanner parameter.

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 property. A warning will appear in the Enterprise portal in the Security settings alerting you to insufficient contrast between the two properties. This property is required by the informationalBanner parameter.

Example

"fontColor": "blue"
enabled

Determines if the access notice or informational banner is enabled. This property is required by the anonymousAccessNotice, authenticatedAccessNotice, and informationalBanner parameters.

Values: true | false

Example usage

Below is a sample POST request for edit, formatted for readability:

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
}&f=json

JSON Response example

{"success": true}