Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/support
esri/workers
Class: ServerInfo

require(["esri/ServerInfo"], function(ServerInfo) { /* code goes here */ });

Description

(Added at v2.5)
This class contains information about an ArcGIS Server and its token endpoint.

Samples

Search for samples that use this class.

Properties

NameTypeSummary
adminTokenServiceUrlStringThe token service URL used to generate tokens for ArcGIS Server Admin resources.
currentVersionNumberVersion of the ArcGIS Server or Portal deployed on the server.
hasPortalBooleanIndicates whether the server is a Portal instance.
hasServerBooleanIndicates whether the server is an ArcGIS Server instance.
serverStringThe server URL.
shortLivedTokenValidityNumberValidity of short-lived token in minutes.
tokenServiceUrlStringThe token service URL used to generate tokens for the secured resources on the server.
webTierAuthBooleanIndicates whether the server is configured to work with web tier authentication.

Methods

NameReturn typeSummary
toJson()ObjectReturn the properties of this object in JSON.
Property Details

<String> adminTokenServiceUrl

The token service URL used to generate tokens for ArcGIS Server Admin resources. (Added at v3.0)

<Number> currentVersion

Version of the ArcGIS Server or Portal deployed on the server. Note: This value will be `8.4` for ArcGIS Online. (Added at v3.0)

<Boolean> hasPortal

Indicates whether the server is a Portal instance.
Known values: true | false

<Boolean> hasServer

Indicates whether the server is an ArcGIS Server instance. See the IdentityManager.registerServers()> for additional information.
Known values: true | false

<String> server

The server URL. This value includes the path to the web adapter for Servers (e.g. https://sampleserver6.arcgisonline.com/arcgis) and Portals (e.g. https://portal.esri.com/gis).

<Number> shortLivedTokenValidity

Validity of short-lived token in minutes. (Added at v3.0)

<String> tokenServiceUrl

The token service URL used to generate tokens for the secured resources on the server.

<Boolean> webTierAuth

Indicates whether the server is configured to work with web tier authentication. (Added at v3.40)
Default value: null
Method Details

toJson()

Return the properties of this object in JSON. (Added at v2.8)
Return type: Object
Show Modal