- URL:https://<system-url>/properties
- Operations:Update
- Required Capability:Default administrator role | Security and infrastructure privilege | Organization website privilege
- Version Introduced:10.3
Description
The properties resource lists system properties that have been modified to control the ArcGIS Enterprise portal environment.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default response format is html. Values: html | json | pjson |
System properties
Note:
If your forward proxy is configured to exclusively use HTTPS, do not include HTTP properties in the request.
| Property | Details |
|---|---|
| allowLegacyURLParser | This property was introduced at 10.6. By default, the property is not listed and its value is false. When added and set to true, braces { }, brackets [ ], and pipe | special characters are allowed in URL query strings unencoded. At 10.7 and later, double quotes " are also allowed in URL query strings unencoded. Note:It is recommended that you do not enable this property, as it carries a security vulnerability. If you do add or change the property, Portal for ArcGIS will need to be manually restarted for changes to take effect. |
| defaultJsonResponseContentType | At 10.6, the default content-type for JSON and JSON with callback responses has been changed from text/plain to application/json and application/javascript, respectively. To revert the content-type of your Portal Services REST API to text/plain, insert this parameter: {"defaultJsonResponseContentType": "text/plain"}. The only value this parameter will accept is text/plain. You should carefully consider the security risks of changing the content-type of JSON responses in your Enterprise portal. |
| disableSignup | If you want to create all accounts manually, this property allows you to disable the sign-up page and prevent users from creating their own accounts. To allow users to create new accounts, set this property to false. Starting at 10.7, to set the property to false, you must have a default user type and role set under Security Configuration. Values: true | false |
| diskThresholdforReceivingCollaboratedContentInGB | This property was introduced at 10.6.1 and controls when, based on available disk space, the Enterprise portal will stop receiving collaborated content. The default disk space value is 10 GB. The minimum allowed value is 1 GB. The specified size must be in GB. |
| enableNosniffHeader | This property was introduced at 10.7. When set to true, all network communication from the Enterprise portal includes the X-Content-Type-Options response header with a value of nosniff. This helps protect against MIME confusion attacks by preventing web browsers from MIME sniffing a response away from the declared content-type of an asset. The default value is true. Values: true | false |
| privatePortalURL | Specifies the internal URL that ArcGIS Server should use to communicate with the Enterprise portal. This property is typically used when you have a highly available ArcGIS Enterprise deployment, or if the server cannot communicate directly with the Enterprise portal machine. Example |
| portalLocalHostname | Informs the Enterprise portal back end to present the value of this property as the host name of the local portal machine. This is typically used during federation and when the Enterprise portal machine has one or more public host names. |
| httpProxyHost | Specifies the HTTP host name of the proxy server. |
| httpProxyPort | Specifies the HTTP port number of the proxy server. |
| httpProxyUser | Specifies the HTTP proxy server user name. |
| httpProxyPassword | Specifies the HTTP proxy server password. |
| isHttpProxyPasswordEncrypted | Set this property to false when you are configuring the HTTP proxy server password in plain text. After configuration, the password will be encrypted, and this property will be set to true. |
| httpsProxyHost | Specifies the HTTPS host name of the proxy server. |
| httpsProxyPort | Specifies the HTTPS port number of the proxy server. |
| httpsProxyUser | Specifies the HTTPS proxy server user name. |
| httpsProxyPassword | Specifies the HTTPS proxy server password. |
| isHttpsProxyPasswordEncrypted | Set this property to false when you are configuring the HTTPS proxy server password in plain text. After configuration, the password will be encrypted, and this property will be set to true. |
| ldapCertificateValidation | Introduced at 10.7. When set to true, any encrypted LDAP communication (LDAPS) made from the Enterprise portal to the user or group identity store will enforce certificate validation. The default value is false. Note:When set to true, if the certificate name does not match or the certificate cannot be validated, the Enterprise portal may attempt to use unencrypted LDAP communication or it may not be able to establish communication at all. If this occurs, a warning message will be logged. |
| nonProxyHosts | This property should always contain the machine name where Portal for ArcGIS is installed. If you want to federate ArcGIS Server , this property should also include the name of the machine where ArcGIS Server is installed. If the ArcGIS Server site contains multiple machines, a wildcard can be used for all machines in the domain (for example, *.domain.com). Machine and domain items are separated using a pipe (|). |
| WebContextURL | Explicitly defines the organization URL used for client communication. This property is required for sites with reverse proxy implementations and architectures without web adaptors. Using WebContextURL is recommended for sites using a DNS alias for the organization URL. Example |
| enablePrintService | Introduced at 10.9. When set to false, the default print service that is distributed with the ArcGIS Enterprise portal is disabled. This change does not impact access to any other configured print service. The default value is true. Values: true | false |
| enableLegendsService | Introduced at 10.9. When set to true, the legend service used to retrieve legend icons from older maps and feature services is enabled. The default value is false. Values: true | false |
| enableRssService | Introduced at 10.9. When set to false, the service used by the ArcGIS Enterprise portal to communicate with the live GeoRSS feed is disabled. The default value is true. Values: true | false |
| enableKmlService | Introduced at 10.9. When set to false, the service used by the ArcGIS Enterprise portal to communicate with the KML endpoint is disabled. The default value is true. Values: true | false |
| enableWfsService | Introduced at 10.9.1. When set to true, the WFS adaptor that is distributed with the ArcGIS Enterprise portal is enabled. This change does not impact access to WFS services added to, or hosted by, the portal. The default value is false. Values: true | false |
Example usage
The following is a sample request URL for the properties resource:
https://machine.domain.com/webadaptor/portaladmin/system/properties?f=jsonJSON Response syntax
{
"propertyName1": "value1",
"propertyName2": "value2",
...
}JSON Response example
{
"disableSignup": "true",
"httpProxyHost": "forwardproxy.domain.com",
"httpsProxyHost": "forwardproxy.domain.com",
"httpProxyPort": 80,
"httpsProxyPort": 443,
"nonProxyHosts": "localhost|machine012.domain.com|*.domain.com"
}