摘要
返回门户信息字典。
GetPortalDescription 函数返回当前匿名或已登录用户所查看的门户的视图。 其中包含门户的名称、徽标、要素项目和支持的协议（HTTP 与 HTTPS）等信息。 如果用户尚未登录，该调用将返回门户的默认视图。 如果用户已登录，将返回用户所属组织特定的门户视图。 门户的默认视图取决于从用户的配置文件中获取的用户语种。
说明
下表包含一系列更重要的门户属性。
| 属性 | 详细说明 |
|---|---|
| access | 匿名用户对于您的组织的访问权限级别。 如果设置为 private，则只有组织成员能够访问站点，而 public 设置则允许公共访问。 |
| allowedBetaFeatures | 为组织启用的一系列测试版功能。 |
| allowedOrigins | 一组数量多达 100 的 Web 应用程序域，用于限制对 ArcGIS Online REST API 的 CORS 访问。 |
| allowedRedirectUris | 允许的重定向 URI 的 JSON 数组，其中 URI 用于表示与您共享安全内容的门户实例。 这将允许组织中的用户使用组织登录帐户，通过这些门户上托管的 web 应用程序访问受保护内容。 |
| allSSL | 指示组织是否使用 HTTPS。 如果设置为 true，则使用属于组织的资源进行的所有调用都将需要使用 HTTPS。 默认为 false。 |
| analysisLayersGroupQuery | 可识别群组的查询，该群组包含在分析工具的分析图层库中进行显示的图层。 |
| appInfo | 有关资源所访问应用程序的信息。 该信息基于用来访问资源的令牌。 |
| authorizedCrossOriginDomains | 一组受信任的服务器，通过跨域资源共享 (CORS) 请求访问受 web 层保护的服务时，客户端可以向其发送凭据。 |
| availableCredits | 组织中的配额总数。 |
| backgroundImage | 主页上所有其他组件下方显示的背景图像。 接受默认背景图像，指定自定义背景图像的 URL 或指定不使用背景图像。 |
| basemapGalleryGroupQuery | 可识别群组的查询，该群组包含在 Map Viewer 经典版 底图库中进行显示的 Web 地图。 |
| bingKey | 适用于使用 Bing Maps 的 Web 地图的 Bing 密钥。 |
| canListApps | 仅当 canListApps 设置为 true 时，组织才能列出应用商店中的应用程序。 |
| canListData | 仅当 canListData 设置为 true 时，组织才能列出应用商店中的数据服务。 |
| canListPreProvisionedItems | 仅当 canListPreProvisionedItems 设置为 true 时，组织才能列出应用商店中的预配置项目。 |
| canProvisionDirectPurchase | 仅当 canProvisionDirectPurchase 设置为 true 时，组织才能在没有客户请求的情况下配置应用商店中的直接购买。 |
| canSearchPublic | 包括或排除搜索查询中的公共项目、群组和用户。 如果 canSearchPublic 设置为 false，则搜索不包含组织外部的公共项目。 但是，可返回作为组织一部分的公共项目。 默认为 true。 |
| canShareBingPublic | Bing 密钥可共享给公众并可作为门户描述调用的一部分返回 (/sharing/rest/portals/<orgid>)。 这需要将门户的 access 属性设置为 public。 canShareBingPublic 属性不会公开返回，且仅对组织内的用户可见。 |
| canSharePublic | 指示组织是否可以公开共享群组或项目。 如果 canSharePublic 设置为 false，则无法将内容共享给所有人。 默认为 true。 |
| canSignInArcGIS | 允许具有已配置企业 IDP 的组织打开或关闭 ArcGIS 登录。 默认为 true。 |
| canSignInIDP | 允许具有已配置企业 IDP 的组织打开或关闭企业登录。 默认为 true。 |
| colorSetsGroupQuery | 可识别群组的查询，该群组包含在 Map Viewer 经典版 中进行渲染的颜色集。 |
| commentsEnabled | 允许组织禁用评论功能。 默认为 true。 当 commentsEnabled 为 false 时，注释将被隐藏，但不会被移除，并且对于组织中的所有项目，numComments 均设置为零。 用于添加评论和查看评论的调用将失败。 如果组织重新启用评论，则会显示评论并恢复 numComments。 |
| contacts | 一组选定的管理员 - 当组织成员请求密码重置、有关用户名的帮助、帐户修改或任何与其帐户配额分配相关的问题时，发送给组织成员的自动电子邮件通知会将选定管理员及其电子邮件地址列为联系方。 |
| contentCategorySetsGroupQuery | 可识别群组的查询，该群组包含 ArcGIS Online 内容类别集。 |
| created | 组织的创建日期，以毫秒为单位表示某一时间点的 UTC 时间。 |
| creditAssignments | 指示组织是否已启用配额预算。 默认为 disabled。 |
| culture | 组织的区域设置或语种代码信息（国家 - 语言），例如 en-us。 |
| cultureFormat | 符合 CLDR 的首选数字和日期格式。 cultureFormat 属性仅适用于英语和西班牙语，即 culture 设置为 en 或 es 时。 有关支持格式，请参阅语言。 |
| customBaseUrl | 门户的自定义基本 URL。 |
| defaultBasemap | Map Viewer 经典版 中显示的默认底图。 |
| defaultDevBasemap | Map Viewer 经典版 中针对开发人员订阅显示的默认底图。 |
| defaultExtent | 组织的默认范围。 |
| defaultUserCreditAssignment | 新成员的默认配额分配。 |
| defaultVectorBasemap | 当 useVectorBasemaps 为 true 时，在 Map Viewer 经典版 中显示的默认矢量底图。 |
| description | 组织的描述。 |
| devbasemapGalleryGroupQuery | 可识别群组的查询，该群组包含在开发人员订阅的 Map Viewer 经典版 底图库中显示的 Web 地图。 |
| eueiEnabled | 表示组织是否允许 ArcGIS Online 收集成员的使用情况信息，用于提升用户体验。 |
| featuredGroups | 组织的专题群组。 这些群组将在群组页面上高亮显示。 |
| featuredItemsGroupQuery | 可识别群组的查询，该群组包含图库的专题项目。 设置群组 ID，如果为空，则组织中最常查看的项目将显示在库中。 |
| galleryTemplatesGroupQuery | 此查询可识别是否允许包含库模板的群组构建在群组内显示 web 地图和 web 制图应用程序的图库。 |
| hasCategorySchema | 指示组织是否设置了内容类别。 |
| helpBase | 提供帮助文档的基本 URL。 可用于构建门户中的所有帮助 URL。 从 ArcGIS Enterprise 10.8.1 开始，可以更新 helpBase，从而使默认文档源成为 ArcGIS Enterprise 用户文档的 Web 版本而非帮助文档的本地安装版本。 要了解详细信息，请参阅更新。 注：文档源仅对通过 Enterprise 门户主页应用程序访问的文档有影响，不会影响 ArcGIS Server 或者 ArcGIS REST API 文档。 |
| helperServices | 客户端应用程序所需的各种服务的 JSON 对象。 可被组织或门户覆盖。 服务包括以下内容：
|
| homePageFeaturedContent | 包括要显示在主页上的专题内容的群组。 |
| homePageFeaturedContentCount | 可显示在主页上的专题项目的数量。 最大值为 100。 只能使用整数。 |
| httpPort | 门户用于 HTTP 通信的端口。 |
| httpsPort | 门户用于 HTTPS 通信的端口。 |
| id | 组织 ID。 如果为空，这将成为匿名用户和无组织用户的默认门户。 |
| ipCntryCode | 调用 IP 的国家代码（仅限 ArcGIS Online）。 |
| isPortal | 指示门户是否为本地门户。 |
| isVerified | 用于指示组织身份是否由 Esri 进行了验证。 |
| layerTemplatesGroupQuery | 用于识别群组的查询，该群组包含在 Map Viewer 经典版 中使用的编辑模板。 |
| livingAtlasGroupQuery | 可识别群组的查询，该群组包含分析图层库中使用的图层。 |
| maxTokenExpirationMinutes | 为组织用户颁发的 OAuth 和 nonOAuth 令牌的最长有效期（以分钟为单位）。 默认值为 -1，对于 OAuth 访问令牌和 ArcGIS 令牌 (nonOAuth)，最大值为 2 周，对于 OAuth 刷新令牌，最大值为 90 天。 这些是受支持的最大值。 指定较小的值将会影响所有三种类型的令牌（ArcGIS 令牌、OAuth 访问令牌和 OAuth 刷新令牌）。 |
| metadataEditable | 指示组织是否已启用元数据。 如果 metadataEditable=true，则组织的所有成员均可查看元数据。 仅项目所有者和管理员可以更新元数据。 如果 metadataEditable=false，则组织中的任何人都无法访问元数据。 值：true | false |
| metadataFormats | 用于组织的元数据样式。 默认为 iso19139。 值：fgdc | inspire | iso19139 | iso19139-3.2 | iso19115 示例： metadataFormats：iso19139-3.2 |
| mfaAdmins | 显示是否允许组织成员为其个人帐户设置多因子身份验证。 |
| mfaEnabled | 显示是否允许组织成员为其个人帐户设置多因子身份验证。 |
| modified | 上次修改组织的日期，以毫秒为单位表示某一时间点的 UTC 时间。 |
| name | 组织的名称。 |
| orgEmail | 显示在 ArcGIS Marketplace 中组织列表的提供者选项卡中的联系人电子邮件。 |
| orgPhone | 显示在 ArcGIS Marketplace 中组织列表的提供者选项卡中的联系人电话号码。 |
| orgUrl | 在 ArcGIS Marketplace 中组织列表中的提供者选项卡中显示的网站 URL。 |
| portalHostname | 门户主机的 URL。 |
| portalMode | 识别其是否为 multitenant 或 singletenant。 |
| portalName | 门户的名称。 |
| portalProperties | 存储特定于组织的属性，例如“联系我们”链接。 如果组织是公共组织，则这些属性对匿名用户可见。 |
| portalThumbnail | 门户缩略图的 URL。 |
| region | 组织的区域。 |
| rotatorPanels | 主页的自定义 HTML。 |
| showHomePageDescription | 如果为 true，则主页上将显示组织的描述。 |
| storageQuota | 允许的总存储（以字节为单位）。 组织通常为 2 TB，非组织通常为 2 GB。 |
| storageUsage | 所使用的总存储（以字节为单位）。 |
| stylesGroupQuery | 可识别群组的查询，该群组包含多种样式，这些样式中包含对可在 ArcGIS 平台中使用的符号系统的引用。 |
| supportsHostedServices | 指示是否支持托管服务。 |
| supportsOAuth | 指示是否支持 OAuth。 |
| symbolSetsGroupQuery | 可识别符号集组的查询，用于在 Map Viewer 经典版 中进行渲染。 |
| templatesGroupQuery | 可识别在 Map Viewer 经典版 中使用的模板组的查询。 |
| thumbnail | 组织缩略图的 URL。 |
| units | 设置适用于组织用户的测量单位。 用户默认值来源于组织的区域。 将单位设置为 english（适用于美制）或 metric。 |
| updateUserProfileDisabled | 指示是否允许组织成员编辑个人信息以及可以查看其个人资料的用户。 |
| urlKey | 由组织管理员选择的要与 customBaseURL 一起使用的前缀。 |
| user | 仅当传递令牌时，才会返回访问用户的用户信息。 不提供群组信息。 有关响应属性的信息，请参阅用户。 |
| useStandardizedQuery | 如果设置为 true，则查询图层和表时，只能使用符合 SQL92 的 WHERE 子句。 建议的安全设置为 true。 |
| useVectorBasemaps | 如果 true，则组织将在受支持的 ArcGIS 应用程序中使用 Esri 矢量底图，同时 basemapGalleryGroupQuery 将不可编辑，且将被设置为默认查询。 |
| vectorBasemapGalleryGroupQuery | 此查询用于识别包含矢量底图的群组，这些底图用于在 Map Viewer 经典版 底图库中显示。 仅应在 useVectorBasemaps 为 true 时使用此查询。 |
| 属性 | 详细说明 |
|---|---|
| orgCapabilities | 通过 ID 返回有关当前门户的订阅信息，用于组织扩展模块的身份验证。 |
语法
GetPortalDescription ({portal_URL})| 参数 | 说明 | 数据类型 |
portal_URL | The portal URL. If unspecified, the active portal will be used. | String |
| 数据类型 | 说明 |
| Dictionary | 包含门户信息的字典。 |
代码示例
获取门户帮助服务 URL 的字典。
import arcpy
portal_desc = arcpy.GetPortalDescription()
helper_services = portal_desc['helperServices']获取门户的用户权限。
import arcpy
portal_desc = arcpy.GetPortalDescription()
user_name = portal_desc['user']['fullName']
user_privileges = portal_desc['user']['privileges']