- URL:
- https://<root>/orgs/<orgID>/federation/servers/federate
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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
| Parameter | Details |
|---|---|
(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 |
(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 |
(Required) | The username of the primary administrator account for the server. If this account is disabled, you'll need to reenable it. Example |
(Required) | The password of the primary administrator account for the server. Example |
| The response format. The default format is Values: |
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.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
url=https://organization.example.com/context&adminUrl=https://gisserver.example.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"}