Federate

URL:
https://<root>/orgs/<orgID>/federation/servers/federate
Methods:
POST
Required Capability:
Access allowed with the "Servers" privilege
Version Introduced:
10.9

Description

The federate operation federates either a GIS Server, ArcGIS Image Server, or a Workflow Manager Server with an organization.

The federate operation performs a validation check to determine whether the provided service and administrative URLs are accessible. If the resulting validation check fails, a warning is returned. A SEVERE log type is also returned in the organization's logs. After federation, administrators will be unable to set a server role for the federated server.

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, Image, or Workflow Manager 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.

Example
1
url=https://organization.domain.com/context

adminUrl

(Required)

The URL used to access 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
1
adminUrl=https://gisserver.domain.com:6443/arcgis

username

(Required)

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

Example
1
username=KBadmin

password

(Required)

The password of the primary administrator account for the server.

Example
1
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:

1
2
3
4
5
6
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

1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close