- URL:
- https://<root>/services/federate
- Methods:
POST- Version Introduced:
- 10.2
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Server Administrator API must include a token in the request body.
Description
The federate operation imports any services that you have previously published to your server site and makes them available as items within the organization you are federating the server with. Services are imported automatically as part of the federate process.
If the automatic import of services fails as part of the federation process, the following severe-level message will appear in the server logs:
Failed to import GIS services as items within portal.If this failure occurs, you can manually re-run the operation to import your services as items in the portal. Before you do this, obtain a portal token and then validate ArcGIS Server is federated with the organization.
After you run the Federate operation, specify sharing properties to determine which users and groups will be able to access each service.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the federate operation:
POST /<context>/admin/services/federate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON Response example
{"status": "success"}