Security Configuration

URL:: https://<notebookserveradmin>/security/config
Methods:: GET
Operations:: Update Security Configuration
Required Capability:: Administrator
Version Introduced:: 10.7

Description

This resource returns the currently active security configuration of the ArcGIS Notebook Server site. A security configuration involves the following parameters and can be modified using the Update operation.

Request parameters

Parameter	Details
`httpsProtocols`	The TLS protocols ArcGIS Notebook Server will use. Values must be separated by commas. Note Ensure that the web server hosting the Web Adaptor can fully communicate over the protocols you're enabling. If you're using ArcGIS Web Adaptor (Java Platform), the web server hosting the Web Adaptor must be using Java 8 or later.
`cipherSuites`	The cipher suites ArcGIS Notebook Server will use. Values must be separated by commas.
`allowInternetCORSAccess`	Setting this property to `true` allows web applications to access services on intranets. When this property is set to `true` (default), ArcGIS Notebook Server sets a response header called `Access-Control-Allow-Private-Network` for HTTP OPTIONS requests. This parameter supports the Private Network Access web specification (CORS-RFC1918), which aims to protect websites accessed over a private network from making internal cross-origin (CORS) requests. Values: `true` \| `false`
`authenticationMode`	Specifies the authentication mode used by ArcGIS Notebook Server. When ArcGIS Notebook Server is federated with an ArcGIS Enterprise portal, this parameter can be included and set to `ARCGIS_PORTAL_TOKEN` . Values: `ARCGIS_TOKEN \| ARCGIS_PORTAL_TOKEN`
`authenticationTier`	The tier at which requests to access GIS services are authenticated. Do not use this directory to modify your setting. The default value when the site is first created is `NOTEBOOK_SERVER` , but when you federate the site with your portal, the value is changed to `ARCGIS_PORTAL` .
`tokenServiceKey`	The key used to encrypt tokens.
`f`	The response format. The default response format is `html` . Values: `html \| json \| pjson`

Portal properties

The following optional properties (portalProperties ) are specified when federating ArcGIS Server with an ArcGIS Enterprise portal:

Property	Details
`portalMode`	Must be the value `ARCGIS_PORTAL_FEDERATION` .
`portalSecretKey`	The key obtained after federating ArcGIS Notebook Server with the portal.
`portalURL`	The URL of the portal in the format `https://organization.example.com/<context>` .
`referer`	The referer specified when generating the token.
`serverId`	The ID of the server federated with the portal.
`serverUrl`	The external URL of the federated ArcGIS Notebook Server in the format `https://notebookserverwebadaptor.example.com/<context>` .
`token`	A token obtained from the portal for initial validation of ArcGIS Notebook Server.
`webgisServerTrustKey`	A key for establishing trust between servers that are federated with the same portal.
`privateHostingServerUrl`	The private URL of the portal's hosting server.
`privatePortalUrl`	The private URL of the portal.

JSON Response example

Use dark colors for code blocksCopy
{
    "serverRole": "FEDERATED_SERVER",
    "authenticationTier": "ARCGIS_PORTAL",
    "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_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_DHE_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_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA256, TLS_DHE_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",
    "serverType": "ARCGIS_NOTEBOOK_SERVER",
    "tokenServiceKey": "JqQZ5aOmOYW7eo4ux/oMZCIHkUkFhO1pTaw=",
    "httpsProtocols": "TLSv1.2",
    "authenticationMode": "ARCGIS_PORTAL_TOKEN",
    "serverFunction": "NotebookServer",
    "portalProperties": {
        "webgisServerTrustKey": "0i5Ey0cKVX+VmDIV/+4Mv2pnEwW9GUD4d8tOZk",
        "portalSecretKey": "ff9c7eec38cc44b7bb0b5408a4c6dcc7",
        "privatePortalUrl": "https://organization.example.com:7443/arcgis",
        "portalUrl": "https://organization.example.com/portal",
        "serverUrl": "https://notebookserverwebadaptor.example.com/dsx",
        "portalMode": "ARCGIS_PORTAL_FEDERATION",
        "privateHostingServerUrl": "https://notebookserver.example.com:6443/arcgis",
        "serverId": "lL6KtZlHyUsIE"
    }
}