ServerInfo
require(["esri/identity/ServerInfo"], function(ServerInfo) { /* code goes here */ });esri/identity/ServerInfoThis class contains information about an ArcGIS Server and its token endpoint.
- See also:
Constructors
- new ServerInfo(properties)
- Parameter:properties ObjectoptionalSee the properties for a list of all the properties that may be passed into the constructor. 
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The token service URL used to generate tokens for ArcGIS Server Admin resources.more details | more details | ServerInfo | |
| Number | Version of the ArcGIS Server deployed on this server.more details | more details | ServerInfo | |
| String | The name of the class.more details | more details | Accessor | |
| Boolean | Indicates whether the server is a Portal instance.more details | more details | ServerInfo | |
| Boolean | Indicates whether the server is an ArcGIS Server instance.more details | more details | ServerInfo | |
| String | The server URL.more details | more details | ServerInfo | |
| Number | Validity of short-lived token in minutes.more details | more details | ServerInfo | |
| String | The token service URL used to generate tokens for the secured resources on the server.more details | more details | ServerInfo | 
Property Details
- adminTokenServiceUrl String
- The token service URL used to generate tokens for ArcGIS Server Admin resources. 
- currentVersion Number
- Version of the ArcGIS Server deployed on this server. 
- Since: ArcGIS API for JavaScript 4.7
- The name of the class. The declared class name is formatted as - esri.folder.className.
- hasPortal Boolean
- See also:
 
- hasServer Boolean
- Indicates whether the server is an ArcGIS Server instance. - See also:
 Example:- // Register the serverInfo with the IdentityManager esriId.registerServers([{ hasServer: true, server: "https://<server domain>/arcgis", tokenServiceUrl: "https://<server domain>/arcgis/tokens/" }]);
- server String
- The server URL. 
- shortLivedTokenValidity Number
- Validity of short-lived token in minutes. 
- tokenServiceUrl String
- The token service URL used to generate tokens for the secured resources on the server. 
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.more details | more details | ServerInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation.more details | more details | ServerInfo | 
Method Details
- fromJSON(json){*}static
- Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input - jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json Object- A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects. Returns:- Type - Description - * - Returns a new instance of this class. 
- toJSON(){Object}
- Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information. Returns:- Type - Description - Object - The ArcGIS portal JSON representation of an instance of this class.