What is portal settings?
Portal settings enables you to customize security configurations, manage dedicated ArcGIS Server sites, and set up services like printing, geocoding, and routing. These settings also allow for the customization of the portal's appearance with logos, banners, and specific content on the home page. Additionally, administrators can configure advanced organization options, manage site configuration groups, and set general preferences such as language and themes.
Configurable settings
Listed are some portal settings you can configure.
| Setting | Options |
|---|---|
| Manage appearance of organization sites | * Adding organization logos. * Add or change organization banners. * Customizing basemaps in Map Viewer or Scene Viewer to match the organization's branding. * Specific content on the home page. |
| User management | * Adding users. * Managing privileges. * Managing groups within the portal to control access to resources based on user roles and permissions. |
| Advanced configurations | * Managing security. * Dedicated server sites. * Managing services for printing, geocoding, geometric calculations, routing, and locale settings. * Streamline user authentication processes using web-tier authentication, SAML (Security Assertion Markup Language), or OpenID Connect. |
| System integration | * Connect external app access for organization members. * Approve apps for member access. * Configure trusted domains for secure connections. * Enable multi-factor authentication for enhanced security. * Configure HTTPS requirements for transactions within the portal. |
How to work with portal settings
To customize portal settings, you use the portal service to set properties.
Interactive tool
You can perform this task by signing in to the portal service as an administrator, you can:
- Navigate to Home > Portals > Self
- Click on Organization Settings.
- Update the Supported Operations list to modify properties according to the organization's requirements.
Code example
Customize portal settings
Here is a Python snippet for customizing portal settings including configuring the portal name, description, logo, banner, and background images.
# Access the portal administration
portal_admin = PortalAdmin(gis)
# Fetch the current portal settings
portal_settings = portal_admin.get_portal_properties()
# Update the portal settings
portal_settings['portalProperties']['name'] = "My Custom Portal"
portal_settings['portalProperties']['description'] = "This is a description of my custom portal."
portal_settings['portalProperties']['logo'] = "https://example.com/logo-image-url.png"
portal_settings['portalProperties']['bannerImage'] = "https://example.com/banner-image-url.jpg"
portal_settings['portalProperties']['backgroundImage'] = "https://example.com/background-image-url.jpg"
# Apply the updated settings
portal_admin.update_portal_properties(portal_settings)What is a self request?
In ArcGIS, a self request to the portal allows you to access organizational settings through the ArcGIS Portal Directory. This allows administrators to learn various capabilities of the portal. To make a self-call using the portal service, you need to send a request to the ArcGIS REST API endpoint.
Code example
List organizational settings
This example shows how to list organizational settings by running a self request using the portal service.
# URL for the self call
url = "https://www.arcgis.com/sharing/rest/portals/self"
# Parameters for authentication
params = {
"f": "json", # Return format: JSON
"token": "", # Leave token empty for now
}
# Authenticate and get a token
login_url = "https://www.arcgis.com/sharing/rest/generateToken"
login_data = {
"username": username,
"password": password,
"referer": "https://www.arcgis.com",
"f": "json"
}
response = requests.post(login_url, data=login_data)
token = response.json().get("token")
# Add the obtained token to the parameters
params["token"] = token
# Make the self call
response = requests.get(url, params=params)
Request
POST arcgis.com/sharing/rest/portals/self HTTP/1.1
Content-Type: application/x-www-form-urlencoded
&f=json
&token=<ACCESS_TOKEN>