// load the Portal and PortalQueryParams modules
require(["esri/portal/Portal",
 "esri/portal/PortalQueryParams",
 "dojo/domReady!"], function(Portal, PortalQueryParams) {
  portal = new Portal();
  // Setting authMode to immediate signs the user in once loaded
  portal.authMode = "immediate";

  // Once portal is loaded, user signed in
  portal.load().then(function() {
    console.log(portal);

    // Create query parameters for the portal search
    // This object autocasts as new PortalQueryParams()
    var queryParams = {
      query: "owner:" + portal.user.username,
      sortField: "numViews",
      sortOrder: "desc",
      num: 20
    };
    // Query the items based on the queryParams created from portal above
    portal.queryItems(queryParams).then(createGallery);
  });
});

Property Overview

Property Details

accessString

The access level of the organization. When public, anonymous users can access the organization. When private, access is restricted to only members of the organization.

Possible Values: public | private

allSSLBoolean

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

authModeString

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

Possible Value	Description
anonymous	An error will be returned when a secure resource is requested.
auto	The user will be signed in when a secure resource is requested.
immediate	The user will be signed in when the Portal is loaded.

Default Value:auto

authorizedCrossOriginDomainsString[]

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

basemapGalleryGroupQueryString

Since: ArcGIS API for JavaScript 4.4

The query that defines the basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is not true. The fetchBasemaps() method does this automatically.

bingKeyString

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

canListAppsBoolean

Indicates whether an organization can list applications in the marketplace .

canListDataBoolean

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

canListPreProvisionedItemsBoolean

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

canProvisionDirectPurchaseBoolean

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

canSearchPublicBoolean

When true, the organization's public items, groups and users are included in search queries. When false, no public items outside of the organization are included. However, public items which are part of the organization are included.

Default Value:true

canShareBingPublicBoolean

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.

Default Value:false

canSharePublicBoolean

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

Default Value:false

canSignInArcGISBoolean

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

Default Value:false

canSignInIDPBoolean

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

Default Value:false

colorSetsGroupQueryString

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

commentsEnabledBoolean

Indicates whether to allow the organization to disable commenting. When commentsEnabled is false, comments are hidden and not removed. numComments are set to zero for all items in the organization. Calls to add a comment and view comments will fail. If the organization re-enables comments, the comments display and numComments are restored.

Default Value:false

createdDate

Date the organization was created.

cultureString

The default locale (language and country) information.

customBaseUrlString

The custom base URL for the portal.

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

defaultBasemapBasemap

The default basemap to use for the portal. Used in the map viewer.

defaultExtentExtent

The default extent to use for the portal. Used in the map viewer. The extent will be in the default basemap's spatial reference.

defaultVectorBasemapBasemap

Since: ArcGIS API for JavaScript 4.4

The default vector basemap to use for the portal. Used in the map viewer.

descriptionString

A description of the organization/portal.

eueiEnabledBoolean

Since: ArcGIS API for JavaScript 4.7

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

Default Value:false

featuredGroupsObject[]

The featured groups for the portal. Returns an array of objects that provide access to the owner and title for each featured group. Each item in this array has the following specification:

Properties:

owner String Name of the group owner.

title String Group title.

featuredItemsGroupQueryString

The query that defines the featured group. If null, then the most viewed items in the organization will be the featured items.

galleryTemplatesGroupQueryString

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

hasCategorySchemaBoolean

Since: ArcGIS API for JavaScript 4.8

Indicates whether the organization has content categories.

Default Value:false

helperServicesObject

Since: ArcGIS API for JavaScript 4.4

Helper services provided by the portal. For the detailed information about these services, see the about utility services topic from the ArcGIS Server documentation.

homePageFeaturedContentString

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

homePageFeaturedContentCountNumber

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

httpPortNumber

The port used by the portal for HTTP communication.

httpsPortNumber

The port used by the portal for HTTPS communication.

idString

The id of the organization that owns this portal. If null then this is the default portal for anonymous and non-organizational users.

ipCntryCodeString

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

isOrganizationBooleanreadonly

Indicates whether the portal is an organization.

isPortalBoolean

Indicates if the portal is on-premises.

layerTemplatesGroupQueryString

The query that identifies the group containing editing templates.

loadedBooleanreadonly

Indicates whether the portal's resources have loaded. When true, all the properties of the object can be accessed.

Default Value:false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value:null

loadStatusStringreadonly

Represents the status of a load operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default Value:not-loaded

loadWarningsObject[]readonly

A list of warnings which occurred while loading.

maxTokenExpirationMinutesNumber

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 OAuth 2.0 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.

modifiedDate

Date the organization was last modified.

nameString

Name of the organization.

portalHostnameString

URL of the portal host.

portalModeString

The portal mode.

Possible Values: multitenant | singletenant

portalPropertiesObject

Properties specific to the organization, for example the "contact us" link. If the organization is public, the properties are visible to the anonymous user.

regionString

The region for the organization.

restUrlStringreadonly

The REST URL for the portal, for example "https://www.arcgis.com/sharing/rest" for ArcGIS Online and "https://www.example.com/arcgis/sharing/rest" for your in-house portal.

rotatorPanelsObject[]

Custom HTML for the home page.

showHomePageDescriptionBoolean

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

supportsHostedServicesBoolean

Indicates whether hosted services are supported.

Default Value:false

symbolSetsGroupQueryString

The query that defines the symbols sets.

templatesGroupQueryString

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

thumbnailUrlStringreadonly

The URL to the thumbnail of the organization.

unitsString

Sets the units of measure for the organization's users. The user default is derived from the organization's region.

Possible Values: english | metric

urlString

The URL to the portal instance. Setting the location of the portal instance via esriConfig.portalUrl should be used in favor of setting it directly on this property.

If using an on-premise portal, the syntax should look similar to: https://www.example.com/arcgis

Default Value:esriConfig.portalUrl

urlKeyString

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

userPortalUser

Information representing a registered user of the portal.

useStandardizedQueryBoolean

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

useVectorBasemapsBoolean

Since: ArcGIS API for JavaScript 4.4

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. The fetchBasemaps() method automatically uses vectorBasemapGalleryGroupQuery.

vectorBasemapGalleryGroupQueryString

Since: ArcGIS API for JavaScript 4.4

The query that defines the vector tiles basemaps that should be displayed in the BasemapGallery when useVectorBasemaps is true. The fetchBasemaps() method does this automatically.

Method Overview

Method Details

cancelLoad()

Cancels a load() operation if it is already in progress.

fetchBasemaps(basemapGalleryGroupQuery){Promise<Basemap[]>}

Fetches the basemaps that are displayed in the BasemapGallery. When useVectorBasemaps is true, the basemaps will be based on vectorBasemapGalleryGroupQuery, and otherwise on basemapGalleryGroupQuery.

Parameter:

basemapGalleryGroupQuery String optional When provided, this argument is used to fetch basemaps based on input query parameters.

Returns:

Type	Description
Promise<Basemap[]>	Resolves to an array of Basemap objects representing the basemaps used in the Basemap Gallery of the Portal.

Example:

portal.fetchBasemaps("title:\"Cloud Creek Basemaps\" AND owner:jsmith")
 .then(function(basemaps){
   // do something with the basemaps
 });

fetchCategorySchema(){IPromise<Object[]>}

Since: ArcGIS API for JavaScript 4.8

If present, fetches the organization's category schema.

Returns:

Type	Description
IPromise<Object[]>	Resolves to an array of objects containing the following properties: Property Type Description title string The title of the category schema. categories object[] An array of objects containing a title and an array of categories.

Example:

// Fetches the category schema
portal.fetchCategorySchema().then(function(schemas){
  schemas.forEach(function(schema){
    console.log("schema: ", schema);
  });
});

fetchFeaturedGroups(){Promise<PortalGroup[]>}

Fetches the featured groups in the Portal.

Returns:

Type	Description
Promise<PortalGroup[]>	Resolves to an array of PortalGroup objects.

Example:

// fetch featured groups
portal.fetchFeaturedGroups().then(function(groups){
   groups.forEach(function(group){
     group.fetchMembers().then(function(members){
       console.log("member", members);
     });
   });
});

fetchRegions(){IPromise<Object[]>}

Since: ArcGIS API for JavaScript 4.8

Fetches and returns the associated regions with the portal instance.

Returns:

Type	Description
IPromise<Object[]>	Resolves to an array of objects containing the following properties: Property Type Description localizedName string The localized name for the region. For example, "Australia". name string The name of the region. For example, "Australia". region string Region name. For example, "AU".

See also:

• ArcGIS REST API Documentation

getDefault(){Portal}static

Returns a cached default Portal instance.

Returns:

Type	Description
Portal	The Portal instance.

isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

load(){Promise}

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

Returns:

Type	Description
Promise	Resolves when the resources have loaded.

queryGroups(queryParams){Promise<PortalQueryResult>}

Executes a query against the Portal to return an array of PortalGroup objects that match the input query.

Parameter:

queryParams PortalQueryParams autocast Autocasts from Object The input query parameters defined in PortalQueryParams.

Returns:

Type	Description
Promise<PortalQueryResult>	When resolved, resolves to an instance of PortalQueryResult which contains a results array of PortalGroup objects representing all the groups that match the input query.

See also:

• PortalQueryResult

queryItems(queryParams){Promise<PortalQueryResult>}

Executes a query against the Portal to return an array of PortalItem objects that match the input query.

Parameter:

queryParams PortalQueryParams autocast Autocasts from Object The input query parameters defined in PortalQueryParams.

Returns:

Type	Description
Promise<PortalQueryResult>	When resolved, resolves to an instance of PortalQueryResult which contains a results array of PortalItem objects representing all the items that match the input query.

See also:

• PortalQueryResult

Example:

// Once portal is loaded, user signed in
  portal.load().then(function() {
    console.log(portal);

    // Create query parameters for the portal search
    // This object autocasts as new PortalQueryParams()
    var queryParams = {
      query: "owner:" + portal.user.username,
      sortField: "numViews",
      sortOrder: "desc",
      num: 20
    };

    // Query the items based on the queryParams created from portal above
    portal.queryItems(queryParams).then(createGallery);
  });

queryUsers(queryParams){Promise<PortalQueryResult>}

Executes a query against the Portal to return an array of PortalUser objects that match the input query.

Parameter:

queryParams PortalQueryParams autocast Autocasts from Object The input query parameters defined in PortalQueryParams.

Returns:

Type	Description
Promise<PortalQueryResult>	When resolved, resolves to an instance of PortalQueryResult which contains a results array of PortalUser objects representing all the items that match the input query.

See also:

• PortalQueryResult

Example:

// Once portal is loaded, user signed in
portal.load().then(function() {
   // queryUsers
   // This object autocasts as new PortalQueryParams()
   var queryParameters = {
     query: "username:" + portal.user.username
   };

   portal.queryUsers(queryParameters).then(function(queryResults){
     queryResults.results[0].fetchFolders().then(function(folders){
       folders.forEach(function(folder){
         console.log(" user folder", folder.title);
       });
     });
   });
});

when(callback, errback){Promise}

Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of callback that may be used to chain additional functions.

Example:

// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});