fetchHubGroup

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

The implementation of fetch to use. Defaults to a global fetch.

Additional Headers to pass into the request.

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

The HTTP method to send the request with.

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

Additional parameters to pass in the request.

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

Return the raw response

Access level of the group ("private" | "org" | "public") we are using AccessLevel instead of SettableAccessLevel intentionally due to the Portal API being inconsistent between .access on items vs groups

Whether the user can delete the group, only owners and admins can

Whether the user can edit the group, only owners and admins can

Whether discussions are enabled or disabled

Whether the group accepts members through invitations only

Whether the group is for read only or not

Whether the group is editable

Whether the group is for view only or not

Whether the group is protected or not the group cannot be deleted if protected

Date the entity was created

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

Id of the entity as a string

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

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

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

Source of the updated date

Whether there is a field we are trying to clear, if true, we need to send clearEmptyFields: true to the updateGroup call

Whether members can auto join the group

Description for the group

Whether members of the group are hidden

Member types of the group ("owner" | "admin" | "member" | "none")

Who can join the groups (organization, collaborators, anyone)

Id of the org that the group belongs to Depending who is fetching the group, and the owning org's settings this may not be returned from the Portal API

Username of the owner of the group

Sort field for the Group

Sort order for the Group

User configurable tags

Group thumbnail url (read-only)

Group thumbnail url (read-only)

System configurable typekeywords

The entity's discussion settings

We need a means to enable / disable the "feature/capability" represented by a permission for an entity. e.g. we want to disable events for a site, so we have hub:site:events: false

Links to related things

Array of permission policies that apply to the entity Only permissions with `entity

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"

Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc