@esri/hub.js
@esri/hub.js

fetchOrganization

Function

Fetch an organization from the portal Note: IHubOrganization is a read-only interface for a subset of the IPortal object The full portal is exposed as the portal property on the IHubOrganization object.

  • fetchOrganization(identifier: string, requestOptions: IRequestOptions) : Promise<IHubOrganization>

Parameters

Parameter Type Default Notes
identifier Required string
requestOptions Required IRequestOptions

Available requestOptions

Property Type Notes

Returns

Promise<IHubOrganization>
Property Type Notes
access AccessLevel

Access level of the org - only public or private
portal IPortal

Access to the whole Portal object
tags string[]

tags. Always empty for an org
typeKeywords string[]

typeKeywords. Always empty for an org
url string

URL to the org
createdDate Inherited Date

Date the entity was created
createdDateSource Inherited string

Source of the creation date as a property path e.q item.created
id Inherited string

Id of the entity as a string
name Inherited string

Name of the Entity For Entities backed by items, this is typically the title
type Inherited string

For Item backed results, this will be item.type Otherwise it will be "Group", "User", "Event" etc
updatedDate Inherited Date

Date when the entity was last updated Depending on the entity, this could be derived in many different ways
updatedDateSource Inherited string

Source of the updated date
description Optional string

description of the org
location Optional IHubLocation

location - always null for an org
orgId Optional string

ID of the org, same as the id property
owner Optional string

owner. Always null for an org
thumbnail Optional string

thumbnail image w/o URL
thumbnailUrl Optional string

URL to the thumbnail image
view Optional IWithViewSettings

view settings - always null for an org
source Optional Inherited string

Source of the entity. Exact logic for this tbd, but the intent is to allow the result to be attributed to something other than "owner"
summary Optional Inherited string

Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc
Function defined in common/src/org/fetch.ts:17