- URL:
- https://<root>/security/config
- Methods:
GET
- Required Capability:
- Access allowed with any authorized privilege
- Version Introduced:
- 10.1
Description
The config
resource returns the currently active security configuration. A security configuration involves the following pieces of information, outlined in the Security configuration properties table.
Request parameters
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
Security configuration properties
Property | Details |
---|---|
| A comma separated list of client machine IP addresses that are allowed access to ArcGIS Server. This can be used as an additional security measure to prevent unauthorized access to the site. |
| A Boolean that indicates whether a user with administrator privileges can access the server through port 6080. If Before disabling administrative access on port 6080, ArcGIS Server must be configured to use web tier authentication ( To fully disable access on port 6080, you can optionally disable the primary site administrator account. If ArcGIS Server Manager becomes unavailable or the web server cannot authenticate users who have administrator privileges, you cannot administer the site. To recover this site, re-enable the primary site administrator account and connect to the site through port 6080 with this account. Values: |
| Specifies the authentication mode used by ArcGIS Server. When ArcGIS Server is federated with Portal for ArcGIS, this property can be included and set to Values: |
| Specifies the tier at which requests to access GIS services will be authenticated. It is recommended that you do not modify these values using the Administrator Directory. Instead, use ArcGIS Server Manager to configure web tier authentication or use the Portal for ArcGIS website to federate ArcGIS Server with your portal. Values: |
| Introduced at 10.9.1. A Boolean that controls the value of the Access-Control-Allow-Private-Network response header in a CORS preflight request to a REST service URL. This property supports the Private Network Access web specification (previously CORS-RFC1918), which aims to restrict websites accessed over a private network from making internal cross-origin requests. Values: |
| A Boolean that indicates whether HTTP Strict Transport Security (HSTS) is being used by the site. To enable this property, the Values: |
| A Boolean that indicates whether the site is accessible over HTTP. Values: |
| Specifies the HTTP protocol to be used for communication to and from the ArcGIS Server site. If set to When an ArcGIS Server site is created, all communication to and from the site is sent over HTTP, which is not secure. This means that your credentials sent over an internal network or the Internet are not encrypted and can be intercepted. To prevent the interception of communication, it's recommended that you configure ArcGIS Server and ArcGIS Server Manager (if installed) to enforce Secure Sockets Layer (SSL). When you create a site, a warning-level message in the logs recommends that you update the communication protocol of the site to use SSL. Values: |
| Connection information about the currently active role store. Example
|
| A Boolean that indicates whether security is enabled for a GIS service. The default value is Values: |
| A Boolean that indicates whether the site is accessible over HTTPS (SSL). The default value is Values: |
| Connection information about the currently active user store. Example
|
| A Boolean that indicates whether the server's virtual directories are secure and require authentication. When this property is set to Values: |
| The properties used when federating ArcGIS Server with Portal for ArcGIS. See Portal properties for more information. |
Portal properties
Property | Details |
---|---|
| The portal mode. This must be Example
|
| The key obtained after federating ArcGIS Server with Portal for ArcGIS. Example
|
| The URL of Portal for ArcGIS in the following format: Example
|
| The private URL of the portal's hosting server. |
| The internal URL of Portal for ArcGIS is in the following format: Example
|
| The ID of the server federated with the portal. Example
|
| The external URL of the server federated with the portal in the following format: Example
|
Example usage
The following is a sample request URL used to access the config
resource:
https://machine.domain.com/webadaptor/admin/security/config?f=pjson
JSON Response syntax
{
"securityEnabled": <true|false>,
"authenticationMode": "<Authentication Mode>",
"authenticationTier": "<Authentication Tier>",
"userStoreConfig": <UserStore>,
"roleStoreConfig": <RoleStore>,
"sslEnabled": <true|false>,
"HSTSEnabled": <true|false>,
"httpsProtocols": "<HTTPS protocols>",
"cipherSuites": "<cipher suite list>",
"httpEnabled": <true|false>,
"virtualDirsSecurityEnabled": <true|false>,
"allowInternetCORSAccess": <true|false>,
"portalProperties": {
"portalUrl": "<Portal URL>",
"portalSecretKey": "<Portal Secret Key>",
"portalMode": "ARCGIS_PORTAL_FEDERATION",
"serverId": <ServerID>,
"serverUrl": <ServerURL>,
"token": <token>,
"referer": <referer>
},
"allowDirectAccess": <true|false>,
"Protocol": "<HTTP>|<HTTP_AND_HTTPS>|<HTTPS>",
"allowedAdminAccessIPs": "<Comma separated list of allowed IP addresses>",
"serverRole": "<Assigned server role>",
"serverFunction": "<Server functions>"
}
JSON Response example
{
"securityEnabled": true,
"authenticationMode": "ARCGIS_PORTAL_TOKEN",
"authenticationTier": "ARCGIS_PORTAL",
"userStoreConfig": {
"type": "PORTAL",
"properties": {}
},
"roleStoreConfig": {
"type": "PORTAL",
"properties": {}
},
"sslEnabled": true,
"HSTSEnabled": false,
"httpsProtocols": "TLSv1.2,TLSv1.3",
"cipherSuites": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_AES_256_GCM_SHA384, TLS_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA",
"httpEnabled": false,
"virtualDirsSecurityEnabled": false,
"allowInternetCORSAccess": true,
"portalProperties": {
"portalUrl": "https://machine.domain.com/webadaptor",
"privatePortalUrl": "https://MACHINE.DOMAIN.COM:7443/arcgis",
"portalSecretKey": "ab11b803c57b4ef983d910d5dcfe9fb1",
"portalMode": "ARCGIS_PORTAL_FEDERATION",
"serverId": "llllrc3XWJS40Gto",
"serverUrl": "https://machine.domain.com/webadaptor",
"webgisServerTrustKey": "e4gOXn7Ah1+mx9I5nDpP1497x7EWvLhRqfLzUMY9Vq4=",
"privateHostingServerUrl": "https://machine.domain.com:6443/arcgis"
},
"allowDirectAccess": true,
"serverRole": "HOSTING_SERVER",
"serverFunction": "GeoAnalytics,WorkflowManager"
}