Skip To Content

GetPortalDescription

Summary

GetPortalDescription is used to return the view of the portal as seen by the current user, anonymous or logged in. It includes information such as the name, logo, featured items, and supported protocols (HTTP versus HTTPS) for this portal. If the user is not logged in, this call will return the default view of the portal. If the user is logged in, the view of the returned portal will be specific to the organization to which the user belongs. The default view of the portal is dependent on the culture of the user, which is obtained from the user's profile.

Discussion

The table below contains a list of the more important portal properties.

PropertyDetails
access

Indicates the level of access to your organization for anonymous users. If set to private, only members of the organization will be able to access your site, while public allows public access.

allSSL

Indicates if the organization is using SSL. If true, all calls made against resources that belong to the organization will require SSL. The default is false.

appInfo

Information about the application through which this resource was accessed. This information is based on the token used to access this resource.

backgroundImage

The background image that displays behind all other components on the home page. Accept the default background image, specify a URL for a custom background image, or specify that no background image will display.

basemapGalleryGroupQuery

The query that identifies the group containing the web maps that display in the basemap gallery for the map viewer.

bingKey

The Bing key to use for web maps using Bing Maps.

canListApps

An organization can list applications in the marketplace only if canListApps is true.

canListData

An organization can list data services in the marketplace only if canListData is true.

canListPreProvisionedItems

An organization can list preprovisioned items in the marketplace only if canListPreProvisionedItems is true.

canProvisionDirectPurchase

An organization can provision direct purchases in the marketplace without customer request only if canProvisionDirectPurchase is true.

canSearchPublic

Includes or excludes public items, groups, and users in search queries. When canSearchPublic is false, no public items outside of the organization are included in searches. However, public items that are part of the organization are returned. The default is true.

canShareBingPublic

The Bing key can be shared to the public and is returned as part of a portal's description call (/sharing/rest/portals/<orgid>). This requires the access of the portal to be set to public. The canShareBingPublic property is not returned publicly but only shown to users within the organization.

canSharePublic

Allows or disallows an organization to share groups or items publicly. When canSharePublic is set to false, it denotes that content can not be shared with everyone. The default is true.

canSignInArcGIS

Allows an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign-in. The default is true.

canSignInIDP

Allows an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign-in. The default is true.

colorSetsGroupQuery

The query that identifies the group containing the color sets used for rendering in the map viewer.

commentsEnabled

Allows the organization to disable commenting. The default is true. When commentsEnabled is false, comments are hidden and not removed. numComments is set to zero for all items in the organization. Calls to add a comment and view comments will fail. If the organization reenables comments, the comments display and numComments is restored.

created

Date the organization was created, in UTC, using milliseconds since epoch.

culture

The locale information for the organization (country-language, for example, en-us).

customBaseUrl

The custom base URL for the portal.

defaultBaseMap

The default basemap displayed in the map viewer.

defaultExtent

The default extent for the organization.

description

The description of the organization.

featuredGroups

The featured groups for the organization. These are the groups that will be highlighted on the Groups page.

featuredItemsGroupQuery

The query that identifies the group containing featured items for the gallery. Set a Group ID or, if null, then the most viewed items in your organization are displayed in the gallery.

helpBase

The helpBase property provides the base URL of the help documentation. This is used to build all the help URLs within the portal.

helperServices

A JSON object of various services needed by client applications. They can be overridden by the organization or the portal. The services include the following:

analysis—Hosted geoprocessing services that perform analyses.

asyncClosestFacility—ArcGIS geoprocessing service for asynchronous closest-facility analysis.

asyncLocationAllocation—ArcGIS geoprocessing service for asynchronous location-allocation network analysis.

asyncServiceArea—ArcGIS geoprocessing service for asynchronous service-area analysis.

asyncVRP—ArcGIS geoprocessing service for solving asynchronous vehicle routing problems.

closestFacility—ArcGIS NAServer service for synchronous closest-facility analysis.

elevation—ArcGIS geoprocessing services for elevation analysis.

elevation3DService—Limited Error Raster Compression (LERC) elevation service used by ArcGIS Pro and the Web Scene Viewer.

elevationSync—ArcGIS geoprocessing services for elevation analysis.

geocode—Array of ArcGIS geocoding services to use for geocoding.

geoenrichment—ArcGIS GeoenrichmentServer.

geometry—ArcGIS GeometryServer to use for geometry functions.

hydrology—ArcGIS geoprocessing services for hydrologic analysis.

printTask—ArcGIS PrintServer task to use for printing functionality.

route—ArcGIS NAServer to use for routing functionality.

serviceArea—ArcGIS NAServer service for synchronous service-area analysis.

syncVRP—ArcGIS NAServer service for solving synchronous vehicle routing problems.

traffic—ArcGIS TrafficMapServer service for traffic functionality.

homePageFeaturedContent

The group that contains featured content to be displayed on the home page.

homePageFeaturedContentCount

The number of featured items that can be displayed on the home page. The max is 100. Integers only.

httpPort

The port used by the portal for HTTP communication.

httpsPort

The port used by the portal for HTTPS communication.

id

Organization ID. If null, then this is the default portal for anonymous and nonorganizational users.

ipCntryCode

The country code of the calling IP (ArcGIS Online only).

isPortal

Indicates if the portal is on-premises.

layerTemplatesGroupQuery

The query that identifies the group containing editing templates used in the map viewer.

maxTokenExpiration

The maximum validity in minutes of tokens issued for users of the organization. -1 is the default and is a special value that indicates infinite timeout or permanent tokens. For tokens granted using OAuth2 authorization grant, it represents the maximum validity of refresh tokens. For access tokens, the maximum validity is the lower of two weeks or this value.

modified

Date the organization was last modified, in UTC, milliseconds since epoch.

name

The organization's name.

portalHostname

The portal host's URL.

portalMode

Identifies if multitenant or singletenant.

portalName

The portal's name.

portalProperties

Stores properties specific to the organization, for example, the contact us link. if the organization is public, the properties are visible to the anonymous user.

portalThumbnail

The URL to the thumbnail of the portal.

region

The region for the organization.

rotatorPanels

Custom HTML for the home page.

showHomePageDescription

If true, the description of your organization displays on the home page.

supportsHostedServices

Indicates if hosted services are supported.

supportsOAuth

Indicates if OAuth is supported.

symbolSetsGroupQuery

The query that identifies the symbol set group for rendering in the map viewer.

templatesGroupQuery

The query that identifies the template group used in the map viewer.

thumbnail

The URL to the thumbnail of the organization.

units

Sets the units of measure for the organization's users. The user default is derived from the organization's region. Set units to english for U.S. standards or metric.

urlKey

The prefix selected by the organization's administrator to be used with the customBaseURL.

useStandardizedQuery

If true, only simple WHERE clauses that are compliant with SQL92 can be used when querying layers and tables. The recommended security setting is true.

user

User information for the accessing user is returned only when a token is passed in. Group information is not given. See User for response properties.

Syntax

GetPortalDescription ({portal_URL})
ParameterExplanationData Type
portal_URL

The portal URL. If unspecified the active portal will be used.

String
Return Value
Data TypeExplanation
Dictionary

A dictionary containing portal information

Code sample

GetPortalDescription example 1

Get a dictionary of a portal's helper services URLs.

import arcpy

portal_desc = arcpy.GetPortalDescription()
helper_services = portal_desc['helperServices']
GetPortalDescription example 2

Get user privileges from a portal.

import arcpy

portal_desc = arcpy.GetPortalDescription()
user_name = portal_desc['user']['fullName']
user_privileges = portal_desc['user']['privileges']

Related topics