Configuration - Security | ArcGIS REST APIs

URL:: https://<root>/security/config
Methods:: GET
Operations:: Update, Change Server Role
Version Introduced:: 12.0

Description

The config resource can be utilized to generate a list of all security operations available for an ArcGIS Video Server deployment. Child resources include update which configures security settings using the config operation, and changeServerRole, which allows an administrator to set the role of a Video Server.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The output format for this operation. The default value is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

f

(Required)

The output format for this operation. The default value is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Portal properties

Property	Details
`portalMode`	The portal mode. This must be `ARCGIS_PORTAL_FEDERATION`. Example Use dark colors for code blocksCopy `1 "portalMode": "ARCGIS_PORTAL_FEDERATION"`
`portalURL`	The URL of Portal for ArcGIS in the following format: Example Use dark colors for code blocksCopy `1 "portalUrl": "https://organization.example.com/<context>"`
`privateHostingServerUrl`	The private URL of the portal's hosting server.
`privatePortalUrl`	The internal URL of Portal for ArcGIS is in the following format: Example Use dark colors for code blocksCopy `1 "privatePortalUrl": "https://organization.example.com:7443/<context>"` Note For highly available envrionments, the URL would point to an internal load balancer, rather than to an individual machine: Example Use dark colors for code blocksCopy `1 "privatePortalUrl": "https://lbprivate.example.com:7443/<context>"`
`serverId`	The ID of the server federated with the portal. Example Use dark colors for code blocksCopy `1 "serverId": "pn04lWxDPEh1vLR6"`
`serverURL`	The external URL of the server federated with the portal in the following format: Example Use dark colors for code blocksCopy `1 "serverUrl": "https://organization.example.com/<context>"`

Example usage

The following is a sample request URL used to access the config resource:

Use dark colors for code blocksCopy
https://organization.example.com/video/admin/security/config?f=pjson

JSON Response syntax

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_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",
    "allowInternetCORSAccess": "< true | false >",
    "serverType": "ARCGIS_VIDEO_SERVER",
    "allowDirectAccess": "< true | false >",
    "tokenServiceKey": "<tokenServiceKey>",
    "httpsProtocols": "TLSv1.2,TLSv1.3",
    "authenticationMode": "ARCGIS_PORTAL_TOKEN",
    "serverFunction": "VideoServer",
    "portalProperties": {
        "webgisServerTrustKey": "<webgisServerTrustKey>",
        "portalSecretKey": "<portalSecretKey>",
        "privatePortalUrl": "https://PORTAL.EXAMPLE.COM:7443/arcgis",
        "portalUrl": "https://portal.example.com/portal",
        "serverUrl": "https://server.example.com/video",
        "portalMode": "ARCGIS_PORTAL_FEDERATION",
        "privateHostingServerUrl": "https://server.example.com:6443/arcgis",
        "serverId": "40xS9GgPNu6JatyE"
    }
}

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_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",
    "allowInternetCORSAccess": true,
    "serverType": "ARCGIS_VIDEO_SERVER",
    "allowDirectAccess": true,
    "tokenServiceKey": "n+xrotvbf0vUQEkumAYX9ByMRoTH+HQqHRIKcRt4p0s=",
    "httpsProtocols": "TLSv1.2,TLSv1.3",
    "authenticationMode": "ARCGIS_PORTAL_TOKEN",
    "serverFunction": "VideoServer",
    "portalProperties": {
        "webgisServerTrustKey": "PkmY4mdiA0s0LUgNFn6OANt9F3++qyn+7hCje9HcwTo=",
        "portalSecretKey": "6b1587a784df4bd4bbca3817385c28a6",
        "privatePortalUrl": "https://PORTAL.EXAMPLE.COM:7443/arcgis",
        "portalUrl": "https://portal.example.com/portal",
        "serverUrl": "https://server.example.com/video",
        "portalMode": "ARCGIS_PORTAL_FEDERATION",
        "privateHostingServerUrl": "https://server.example.com:6443/arcgis",
        "serverId": "40xS9GgPNu6JatyE"
    }
}