Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PortalProperties

Hierarchy

Index

Properties

Optional access

access: "public" | "private"

The access level of the organization.

Read more...

Optional allSSL

allSSL: boolean

When true, access to the organization's Portal resources must occur over SSL.

Read more...

Optional authMode

authMode: "auto" | "anonymous" | "immediate"

The authentication mode for handling authentication when the user attempts to access a secure resource.

Read more...

Optional authorizedCrossOriginDomains

authorizedCrossOriginDomains: string[]

Array of trusted servers to send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access services secured with web-tier authentication.

Read more...

Optional basemapGalleryGroupQuery

basemapGalleryGroupQuery: string

The query that defines the basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is not true.

Read more...

Optional bingKey

bingKey: string

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

Read more...

Optional canListApps

canListApps: boolean

Indicates whether an organization can list applications in the marketplace.

Read more...

Optional canListData

canListData: boolean

Indicates whether an organization can list data services in the marketplace.

Read more...

Optional canListPreProvisionedItems

canListPreProvisionedItems: boolean

Indicates whether an organization can list pre-provisioned items in the marketplace.

Read more...

Optional canProvisionDirectPurchase

canProvisionDirectPurchase: boolean

Indicates whether an organization can provision direct purchases in the marketplace without customer request.

Read more...

Optional canSearchPublic

canSearchPublic: boolean

When true, the organization's public items, groups and users are included in search queries.

Read more...

Optional canShareBingPublic

canShareBingPublic: boolean

The Bing key can be shared to the public and is returned as part of a portal's description call (/sharing/rest/portals/<orgid>).

Read more...

Optional canSharePublic

canSharePublic: boolean

When true, members of the organization can share resources outside the organization.

Read more...

Optional canSignInArcGIS

canSignInArcGIS: boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in.

Read more...

Optional canSignInIDP

canSignInIDP: boolean

Indicates whether to allow an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in.

Read more...

Optional colorSetsGroupQuery

colorSetsGroupQuery: string

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

Read more...

Optional commentsEnabled

commentsEnabled: boolean

Indicates whether to allow the organization to disable commenting.

Read more...

Optional created

Date the organization was created.

Read more...

Optional culture

culture: string

The default locale (language and country) information.

Read more...

Optional customBaseUrl

customBaseUrl: string

The custom base URL for the portal.

Read more...

Optional defaultBasemap

defaultBasemap: BasemapProperties

The default basemap to use for the portal.

Read more...

Optional defaultExtent

defaultExtent: ExtentProperties

The default extent to use for the portal.

Read more...

Optional defaultVectorBasemap

defaultVectorBasemap: BasemapProperties

The default vector basemap to use for the portal.

Read more...

Optional description

description: string

A description of the organization/portal.

Read more...

Optional eueiEnabled

eueiEnabled: boolean

Boolean value indicating whether to opt-in to the Esri User Experience Improvement (EUEI) program.

Read more...

Optional featuredGroups

featuredGroups: PortalFeaturedGroups[]

The featured groups for the portal.

Read more...

Optional featuredItemsGroupQuery

featuredItemsGroupQuery: string

The query that defines the featured group.

Read more...

Optional galleryTemplatesGroupQuery

galleryTemplatesGroupQuery: string

The query that identifies the group containing features items for the gallery.

Read more...

Optional hasCategorySchema

hasCategorySchema: boolean

Indicates whether the organization has content categories.

Read more...

Optional helperServices

helperServices: any

Helper services provided by the portal.

Read more...

Optional homePageFeaturedContent

homePageFeaturedContent: string

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

Read more...

Optional homePageFeaturedContentCount

homePageFeaturedContentCount: number

The number of featured items that can be displayed on the home page.

Read more...

Optional httpPort

httpPort: number

The port used by the portal for HTTP communication.

Read more...

Optional httpsPort

httpsPort: number

The port used by the portal for HTTPS communication.

Read more...

Optional id

id: string

The id of the organization that owns this portal.

Read more...

Optional ipCntryCode

ipCntryCode: string

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

Read more...

Optional isPortal

isPortal: boolean

Indicates if the portal is on-premises.

Read more...

Optional isReadOnly

isReadOnly: boolean

Indicates if the portal is in read-only mode.

Read more...

Optional layerTemplatesGroupQuery

layerTemplatesGroupQuery: string

The query that identifies the group containing editing templates.

Read more...

Optional maxTokenExpirationMinutes

maxTokenExpirationMinutes: number

The maximum validity in minutes of tokens issued for users of the organization.

Read more...

Optional modified

modified: DateProperties

Date the organization was last modified.

Read more...

Optional name

name: string

Name of the organization.

Read more...

Optional portalHostname

portalHostname: string

URL of the portal host.

Read more...

Optional portalMode

portalMode: "multitenant" | "singletenant"

The portal mode.

Read more...

Optional portalProperties

portalProperties: any

Properties specific to the organization, for example the "contact us" link.

Read more...

Optional region

region: string

The region for the organization.

Read more...

Optional rotatorPanels

rotatorPanels: any[]

Custom HTML for the home page.

Read more...

Optional showHomePageDescription

showHomePageDescription: boolean

Indicates whether the description of your organization displays on the home page.

Read more...

Optional sourceJSON

sourceJSON: any

The JSON used to create the property values when the Portal is loaded.

Read more...

Optional supportsHostedServices

supportsHostedServices: boolean

Indicates whether hosted services are supported.

Read more...

Optional symbolSetsGroupQuery

symbolSetsGroupQuery: string

The query that defines the symbols sets.

Read more...

Optional templatesGroupQuery

templatesGroupQuery: string

The query that defines the collection of templates that will appear in the template gallery.

Read more...

Optional units

units: "metric" | "english"

Sets the units of measure for the organization's users.

Read more...

Optional url

url: string

The URL to the portal instance.

Read more...

Optional urlKey

urlKey: string

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

Read more...

Optional useStandardizedQuery

useStandardizedQuery: boolean

When true, only simple where clauses that are compliant with SQL92 can be used when querying layers and tables.

Read more...

Optional useVectorBasemaps

useVectorBasemaps: boolean

When true, the organization has opted in to use the vector tile basemaps, and (a) vectorBasemapGalleryGroupQuery should be used instead of basemapGalleryGroupQuery, while (b) defaultVectorBasemap should be used instead of defaultBasemap.

Read more...

Optional user

Information representing a registered user of the portal.

Read more...

Optional vectorBasemapGalleryGroupQuery

vectorBasemapGalleryGroupQuery: string

The query that defines the vector tiles basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is true.

Read more...

Generated using TypeDoc