- URL:
- https://<root>/federation/servers/federate
- Methods:
POST- Version Introduced:
- 10.4
Access requirements
Required privileges
The Portal 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 Portal 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 Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The federate operation enables an ArcGIS Server to be federated with an organization.
Request parameters
| Parameter | Details |
|---|---|
| The URL of the GIS server used by external users when accessing the ArcGIS Server site. If the site includes the Web Adaptor, the URL includes the Web Adaptor address. If you've added ArcGIS Server to your organization's reverse proxy server, the URL is the reverse proxy server address. Note that the federation operation will perform a validation check to determine if the provided URL is accessible from the server site. If the resulting validation check fails, a warning will be generated in the logs. However, federation will not fail if the URL is not validated, as the URL may not be accessible from the server site, such as is the case when the server site is behind a firewall. Example |
| The URL used for accessing ArcGIS Server when performing administrative operations on the internal network. If you federate with a multimachine site or highly available GIS Server, use the Web Adaptor or load balancer URL in this field instead. The Example |
| The username of the primary site administrator account that was used to initially log in to ArcGIS Server Manager and administer the server. If this account is disabled, you'll need to re-enable it. Example |
| The password of the primary site administrator account. Example |
| The response format. The default response value is Values: |
Example usage
The following is a sample POST request for the federate operation:
POST /<context>/portaladmin/federation/servers/federate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
url=https://organization.example.com/gis&adminUrl=https://organization.example.com:6443/arcgis&username=administrator&password=adminpassword&f=jsonResponse values
Possible status responses include:
successsuccess with warningsfailureundetermined
JSON Response syntax
{
"status": "success",
"serverId": "iSoD09CM73g0tmu9",
"messages": "..."
}