Skip To Content
ArcGIS Developers
Dashboard

Update (Security Configuration)

Description

This operation updated the security configuration for an ArcGIS Enterprise on Kubernetes deployment.

Request parameters

ParameterDetails
securityConfig

The JSON object representing the security configuration for ArcGIS Enterprise on Kubernetes. For information on included properties, see the security configuration properties section below.

f

The response format. The default format is html.

Values: html | json | pjson

Security configuration properties

ParameterDetails
serverRole

The role assigned to the federated server.

userStoreConfig

Connection information about the currently active user store.

roleStoreConfig

Connection information about the currently active role store.

tokenServiceKey

The key used to encrypt tokens.

enableAutomaticAccountCreation

A boolean that indicates if new organization accounts should automatically be created when enterprise users access your Enterprise portal for the first time (true), or whether accounts should be manually created. The default value is false.

Values: true | false

securityEnabled

A boolean that indicates if security is enabled for any GIS service. The default value is true.

Values: true | false

disableServicesDirectory

A boolean that indicates if access to the services directory should be disabled. The default value is false.

Values: true | false

allowedProxyHost

This property restricts what hosts Enterprise portal can access directly. This restriction applies to several scenarios, including when the Enterprise portal accesses resources from a server that does not support Cross Origin Resources Sharing (CORS) or when saving credentials used to access a secure service. By default, this property is not defined and no restrictions are applied. Use the format (.*).domain.com to allow access to all machines within a specified domain.

Portal properties

ParameterDetails
portalURL

The organization URL.

privatePortalUrl

The internal service URL for accessing the portal sharing container.

portalSecretKey

The key obtained after federation an ArcGIS Server to an organization.

portalMode

Must be set as ARCGIS_PORTAL_FEDERATION.

serverId

The ID of the server that is federated with the organization.

serverURL

The external URL of the server federated with the organization.

webgisServerTrustKey

This key used for internal communication. This key is automatically generated during site creation and should not be modified.

Forward proxy config

ParameterDetails
httpProxyHost

The forward proxy hostname for http requests.

httpsProxyHost

The forward proxy hostname for https requests.

httpProxyPort

The forward proxy port number for http requests.

httpsProxyPort

The forward proxy port number for https requests.

httpProxyUser

The forward proxy username for http requests when authentication is required.

httpsProxyUser

The forward proxy username for https requests when authentication is required.

httpProxyPassword

The forward proxy password for http requests when authentication is required.

httpsProxyPassword

The forward proxy password for https requests when authentication is required.

nonProxyHosts

Aa list of hostnames separated by "|" that can be accessed directly and do not require the use of the proxy. Wildcards can be used for an entire domain (*.example.com).

isHttpProxyPasswordEncrypted

A boolean that indicates if the http proxy password is encrypted. When adding or updating the password, this property should be changed to false. Once saved, the password becomes encrypted and this value will be changed to true automatically.

Values: true | false

isHttpProxyPasswordEncrypted

A boolean that indicates if the https proxy password is encrypted. When adding or updating the password, this should be changed to false. Once saved, the password becomes encrypted and this value will be changed to true automatically.

Values: true | false

Example usage

The following is a sample POST request for update, formatted for readability:

POST /context/admin/security/config/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-wwww-form-urlencoded
Content-Length: []

securityConfig={
  "serverRole": "HOSTING_SERVER",
  "userStoreConfig": {
    "type": "BUILTIN",
    "properties": {}
  },
  "groupStoreConfig": {
    "type": "BUILTIN",
    "properties": {}
  },
  "tokenServiceKey": "CXlyzoKXH71nE/ip/2lF1aLUbjFBAyaQ2xV8UtkNH8o=",
  "enableAutomaticAccountCreation": false,
  "securityEnabled": true,
  "disableServicesDirectory": false,
  "portalProperties": {
    "webgisServerTrustKey": "cTKqfkFoXdl2tHJdIoCIoxtAfuN8bAo1BoQqcADMkFY=",
    "portalSecretKey": "d9f410f2f71240aab64dea54e6f983fe",
    "privatePortalUrl": "https://privateportal.domain.local:8443/arcgis/",
    "portalUrl": "https://organization.domain.com/context/",
    "serverUrl": "https://organization.domain.com/context/",
    "includeOrgIdWIthUsername": false,
    "portalMode": "ARCGIS_PORTAL_FEDERATION",
    "serverId": "rXPmB6CgeHlyG9sC"
  },
  "forwardProxyConfig": {
    "httpProxyHost": "proxy.example.com",
    "httpsProxyHost": "proxy.example.com",
    "httpProxyPort": 8888,
    "httpsProxyPort": 8888,
    "httpProxyUser": "username",
    "httpProxyPassword": "password",
    "httpsProxyUser": "username",
    "httpsProxyPassword": "password",
    "nonProxyHosts": "enterprise.example.com|server.example.com",
    "isHttpProxyPasswordEncrypted": false,
    "isHttpsProxyPasswordEncrypted": false
  }
}&f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMw

JSON Response example

{"status": "success"}