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 externalcontent resource returns whether access to external content has been enabled or disabled for an organization. If the resource returns true, an organization's Esri content will contain external URLs that reference sites and resources hosted outside of the organization. If the resource returns false, Esri content containing external URLs will be removed from the organization. Any Esri content remaining after external content is disabled does not contain external URLs.
If you are configuring ArcGIS Enterprise in an environment in which no internet connection is available, or internet access is prohibited, access to external content should be disabled to avoid discovering content containing inaccessible URLs to external sites. An organization's current externalcontent setting can be changed using the Update operation.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the externalcontent resource:
https://organization.example.com/<context>/portaladmin/system/content/externalcontent?f=pjsonJSON Response syntax
{"isExternalContentEnabled": <true|false>}JSON Response example
{"isExternalContentEnabled": true}