Register Server

Description

You can optionally register (or "federate") an ArcGIS Server site with your Portal for ArcGIS deployment. This provides the following benefits:

After you register a server with your portal, you must invoke the Update Security Configuration operation on the ArcGIS Server site and configure the site's security store to take advantage of users and roles from the portal.

This operation is only applicable to Portal for ArcGIS; it is not supported with ArcGIS Online.

Request Parameters

Parameter

Details

[Common Parameters]

For a complete listing, see Common parameters.

name

The fully qualified name of the machine hosting the ArcGIS Server site, followed by the port.

url

The externally visible URL of the ArcGIS Server site, using the fully qualified name of the machine.

adminUrl

The administrative URL of your ArcGIS Server site, using the fully qualified name of the machine.

isHosted

A Boolean property denoting whether the ArcGIS Server site will be allowed to host services for the portal (true) or not be allowed to host services (false).

serverType

The type of server being registered with the portal. For example: ArcGIS.

Response Properties

Property

Details

success

A Boolean property indicating whether the registration was successful.

serverId

An ID assigned to the server. You need to supply this when you call Update Security Configuration on the server after performing the registration.

secretKey

A symmetric key used to identify the server. You need to supply this when you call Update Security Configuration on the server after performing the registration.

Example Usage

http://myportal.mydomain.com/arcgis/sharing/rest/portals/0123456789ABCDEF/servers/register
name: myserver.mydomain.com:6080
url: http://myserver.mydomain.com/arcgis
adminUrl: http://myserver.mydomain.com:6080/arcgis
isHosted: true
serverType: ArcGIS

JSON Response Syntax

{
  "success": true | false,
  "serverId": <serverId>,
  "secretKey": <secretKey>
}

JSON Response Example

{
  "success": true,
  "serverId": "J5TUOrNQurCDgHFq",
  "secretKey": "8ca3030b618e4a8ab86a2f5052d47d21"
}

10/6/2017