Skip To Content
ArcGIS Developers
Dashboard

Federate

Description

This operation federates either an GIS or Image server with an organization. The federate operation performs a validation check to determine if the provided service and admin URLs are accessible. If the resulting validation check fails, a warning will be returned as well as be returned as a SEVERE log type in the organization's logs. After federation, administrators will be unable to set a server roles for the federated server.

Note:

Before federation, GIS and Image servers should be updated to use either CA or domain certificates. Currently, federating a server that users a self-signed certificate is not supported.

Once a server has been federated with an organization, services that exist on the ArcGIS Server site at the time of federation are automatically added to the portal as items. The administrator who performs this operation will be assigned as the imported service's owner and, once the operation is complete, can reassign ownership to other members in the organization. Any subsequent items published to the federated server are automatically added as items on the portal and are owned by the user who publishes them.

Request parameters

ParameterDetails
url

(Required)

The URL of the GIS or Image server used by external users when accessing the server site. If you've added the server to your organization's reverse proxy server, the URL is the reverse proxy server address.

Examples

url=https://organization.domain.com/context
adminUrl

(Required)

The URL used for accessing the server when performing administrative operations on the internal network. The URL must be able to be used by the organization to communicate with all servers in the site, even when one of them is unavailable.

Example

adminUrl=https://gisserver.domain.com:6443/arcgis
username

(Required)

The username of the primary site administrator account for the server. If this account is disabled, you'll need to re-enable it.

Example

username=KBadmin
password

(Required)

The password of the primary site administrator account for the server.

Example

password=adminPass1234
f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the federate operation:

POST /context/admin/orgs/0123456789ABCDEF/federation/servers/federate HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

url=https://organization.domain.com/context&adminUrl=https://gisserver.domain.com:6443/arcgis&username=KBadmin&password=adminPass1234&f=pjson&token=IBFvYfLQOcbpWWtoYlb-_MR27SwCyYicph8dBh9eVD-CAv2yXXoBQHp0t05ZV2yd9uUlx-uP2NAIf-ivlFguuDV8DYX_b-Tf_f-3U9qUN3sG4dhumlt44w2JFGMKGLar7J1nsAmtocoeqN7qXgdKxGOQFyUb7xACcet2yXjrqhyfwm-JyFOfnFc0T7sqb_WNLE_WCaSMczWV3yLOQ5mEgb74zE947HTtgxcexBPneApQoXplLri5V8ZJ4KzOvBrkCWbRckzh67vUIUo0qIMPLA..

JSON Response example

{"status": "success"}