This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.

setItemAccess

Function
import { setItemAccess } from "@esri/arcgis-rest-portal";
//
setItemAccess({
  id: "abc123",
  access: "public", // 'org' || 'private'
  authentication: session
})

Change who is able to access an item.

Parameters

Parameter Type Default Notes
requestOptions Required ISetAccessOptions

Options for the request.

Available requestOptions

Property Type Notes
access "private" | "org" | "public"

"private" indicates that the item can only be accessed by the user. "public" means accessible to anyone. An item shared to the organization has an access level of "org".

authentication Inherited UserSession

A session representing a logged in user.

id Inherited string

Unique identifier for the item.

credentials Optional Inherited RequestCredentials

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

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

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

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

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.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

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

owner Optional Inherited string

Item owner, if different from the authenticated user.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

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'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise that will resolve with the data from the response.

Promise<ISharingResponse>
Property Type Notes
itemId string
notSharedWith Optional string[] | string
notUnsharedFrom Optional string[] | string

Function defined in packages/arcgis-rest-portal/src/sharing/access.ts:36