Security Configuration

Description

This resource returns the currently active security configuration. A security configuration involves the following pieces of information.

Note:

The user and role store can be updated by using the Update Identity Store operation. The remaining security configuration can be updated by using the Update Security Config operation. The security configuration can be represented in JSON format as described in the response section.

  • allowedAdminAccessIPs (Allowed Administration Access IPs)—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.

  • allowDirectAccess (Allow direct administrator access)—A boolean that indicates if a user with administrator privileges can access the server through port 6080.

    If true, all users with administrative access are allowed to access the Administrator Directory and ArcGIS Server Manager through port 6080.

    If false, users in the identity store are blocked from accessing the server through port 6080. This forces users to access the site through the Web Adaptor. Before disabling administrative access on port 6080, ArcGIS Server must be configured to use web tier authentication (WEB_ADAPTOR) and at least one user in the identity store must have administrator privileges to the site. The primary site administrator account will still be able to administer the site through port 6080. To fully disable access on port 6080, you can optionally disable the primary site administrator account. If the Web Adaptor becomes unavailable or the web server is unable to authenticate users that have administrator privileges, you will be unable to administer your site. To recover from this state, re-enable the primary site administrator account and connect to the site through port 6080 with this account.

    Accepted values: true | false

    Default value: true

  • authenticationMode (Authentication Mode)—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 ARCGIS_PORTAL_TOKEN.

    Accepted values: ARCGIS_TOKEN | ARCGIS_PORTAL_TOKEN | WEB_ADAPTOR_AUTHENTICATION

    Default value: ARCGIS_TOKEN

  • authenticationTier (Authentication Tier)—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.

    Accepted values: WEB_ADAPTOR | GIS_SERVER | ARCGIS_PORTAL

    Default value: GIS_SERVER

  • httpEnabled (HTTP Enabled)—A boolean that indicates if the site is accessible over HTTP.

    Accepted values: true | false

    Default value: true

  • Protocol (Protocol)—Specifies the HTTP protocol to be used for communication to and from the ArcGIS Server site. When you initially create your ArcGIS Server site, all communication in 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 any communication, it's recommended that you configure ArcGIS Server and ArcGIS Web Adaptor (if installed) to enforce Secure Sockets Layer (SSL). When you initially create your site, you'll see a warning-level message in the logs recommending that you update the communication protocol of your site to use SSL.

    If HTTP, all communication to and from the site will be over HTTP; HTTPS will be unavailable.

    If HTTP_AND_HTTPS, users and clients may use either HTTP or HTTPS to connect to the site.

    If HTTPS, all communication to and from the site will be over HTTPS. Any call made using HTTP will be redirected to use HTTPS instead.

    Accepted values: HTTP | HTTP_AND_HTTPS | HTTPS

    Default value: HTTP

  • roleStoreConfig (Role Store)—Connection information about the currently active role store.

  • securityEnabled (Security Enabled)—A boolean that indicates if security is enabled for any GIS service.

    Accepted values: true | false

    Default value: true

  • sslEnabled (SSL Enabled)—A boolean that indicates if the site is accessible over HTTPS (SSL).

    Accepted values: true | false

    Default value: false

  • userStoreConfig (User Store)—Connection information about the currently active user store.

  • virtualDirsSecurityEnabled (Virtual Directories Security Enabled)—A boolean that indicates if the server's virtual directories are secured and require authentication.

    If true, accessing the content in the arcgisoutput, arcgisjobs, and arcgisinput directories over HTTP will require user authentication. This will negatively impact performance.

    Accepted values: true | false

    Default value: false

The following optional properties (portalProperties) are specified when federating ArcGIS Server with Portal for ArcGIS.

  • portalMode (Portal Mode)—Must be the value ARCGIS_PORTAL_FEDERATION.

  • portalSecretKey (Portal Secret Key)—The key obtained after federating ArcGIS Server with Portal for ArcGIS.

  • portalUrl (Portal URL)—The URL of Portal for ArcGIS in the format https://webadaptorhost.domain.com/webadaptorname.

  • referer (Referer)—The referer specified when generating the token.

  • serverId (Server ID)—The ID of the server federated with the portal.

  • serverUrl (Server URL)—External URL of the server federated with the portal, in the format https://webadaptorhost.domain.com/webadaptorname.

  • token (Token)—A token obtained from Portal for ArcGIS for use by ArcGIS Server for initial validation.

Request Parameters

ParameterDetails
f

Description: The response format. The default response format is html.

Values: html | json

Response Format

{
    "securityEnabled": <true|false>,
    "Protocol": "<HTTP>|<HTTP_AND_HTTPS>|<HTTPS>",
    "httpEnabled": <true|false>,
    "sslEnabled": <true|false>,
    "virtualDirsSecurityEnabled": <true|false>,
    "allowDirectAccess": <true|false>,
    "authenticationMode": "<Authentication Mode>",
    "authenticationTier": "<Authentication Tier>",
    "userStoreConfig": <UserStore>,
    "roleStoreConfig": <RoleStore>,
    "allowedAdminAccessIPs": "<Comma separated list of allowed IP addresses>",
    "portalProperties": {
        "portalUrl": "<Portal URL>",
        "portalSecretKey": "<Portal Secret Key>",
        "portalMode": "ARCGIS_PORTAL_FEDERATION",
        "serverId": <ServerID>,
        "serverUrl": <ServerURL>,
        "token": <token>,
        "referer": <referer>
    }
}