Set sharing level for an item | Documentation

Learn how to use the portal service to set the sharing level for an item in your portal.

Prerequisites

You need the following for this tutorial:

Account: An ArcGIS Location Platform, ArcGIS Online, or ArcGIS Enterprise account.
Authentication: A basic understanding of API key authentication or User authentication.

Steps

Set up authentication

Create a new API key credential with privileges to access the resources used in this tutorial.

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges
  - Location services > Basemaps
- Item access
  - Note: If you are using your own custom data layer for this tutorial, you need to grant the API key credentials access to the layer item. Learn more in Item access privileges.
When prompted, copy and paste the API key to a safe location. It will be used in the next step.

Set up environment

In a different window, launch Postman and create a blank request.

Create a new private item

You will create a new web map in your portal. The default sharing level will be private. In a later step, you will use the web map item ID to change the sharing level to public using the portal service.

In a different tab, sign in to your portal.
Click on Map to open up Map Viewer.
Add a basemap, layer, and viewpoint for your map.
Click Save > Save as.
Provide a title and tags for your web map. Then, click Save.
In the URL part of your browser, copy the web map item ID and store it in a safe location. You can find the item ID in https://arcgis.com/apps/mapviewer/index.html?webmap=<ITEM_ID>. You will use this item ID in a later step.

Perform a `share` request

Now, you will be changing the sharing level of your item from private to public using the portal service.

Set the request type to POST.
In the URL field, type in https://arcgis.com/sharing/rest/content/users/<USER_NAME>/items/<ITEM_ID>/share. Replace <USER_NAME> with your username and <ITEM_ID> with the item ID you copied in the previous step.
Set the f parameter to pjson in the parameter list.
Set the everyone parameter to true to set the sharing level to public. To see other sharing levels, go to Sharing items.
Set the token parameter to your access token.
Set the q parameter to type: "Web Map" in the parameter list.
Run the request.

HTTP

cURL

Use dark colors for code blocksCopy
POST https://arcgis.com/sharing/rest/content/users/<USER_NAME>/items/<ITEM_ID>/share
Content-Type: application/x-www-form-urlencoded

&f=json
&everyone=true
&token=<YOUR_ACCESS_TOKEN>

Add another <script> tag and import a CDN library for arcgis-rest-portal.

Expand
Use dark colors for code blocks
    <pre id="result"></pre>
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>

    <script src="https://unpkg.com/@esri/arcgis-rest-portal@4.4.0/dist/bundled/portal.umd.js"></script>

    <script type="module">

    </script>
Expand

Import the following classes from the arcgisRest global.

Expand
Use dark colors for code blocks
    <pre id="result"></pre>
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>

    <script src="https://unpkg.com/@esri/arcgis-rest-portal@4.4.0/dist/bundled/portal.umd.js"></script>

    <script type="module">

      const { setItemAccess } = globalThis.arcgisRest
      const { ArcGISIdentityManager } = globalThis.arcgisRest

    </script>
Expand

Create an ArcGISIdentityManager object and pass in your access token.

Expand
Use dark colors for code blocks
    <pre id="result"></pre>
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>

    <script src="https://unpkg.com/@esri/arcgis-rest-portal@4.4.0/dist/bundled/portal.umd.js"></script>

    <script type="module">

      const { setItemAccess } = globalThis.arcgisRest
      const { ArcGISIdentityManager } = globalThis.arcgisRest

      ArcGISIdentityManager.fromToken({
        token: "YOUR_ACCESS_TOKEN", // Access token from OAuth2.0 authorizes action on behalf of an ArcGIS user
      }).then((authentication) => {

      })

    </script>
Expand

Inside the ArcGISIdentityManager block, call the setItemAccess method. Pass in your item ID into the appropriate field and set access to public. This will set the sharing level of your item to public. To see other sharing levels, go to Sharing items.

Expand
Use dark colors for code blocks
    <pre id="result"></pre>
    <!-- require ArcGIS REST JS libraries from https://unpkg.com -->
    <script src="https://unpkg.com/@esri/arcgis-rest-request@4.0.0/dist/bundled/request.umd.js"></script>

    <script src="https://unpkg.com/@esri/arcgis-rest-portal@4.4.0/dist/bundled/portal.umd.js"></script>

    <script type="module">

      const { setItemAccess } = globalThis.arcgisRest
      const { ArcGISIdentityManager } = globalThis.arcgisRest

      ArcGISIdentityManager.fromToken({
        token: "YOUR_ACCESS_TOKEN", // Access token from OAuth2.0 authorizes action on behalf of an ArcGIS user
      }).then((authentication) => {

        return setItemAccess({
          id: "ITEM_ID", // Hosted item
          access: "public",
          authentication: authentication,
        })

      })

    </script>
Expand

Add the following require statement to your code.

Expand
Use dark colors for code blocks
       const esriRequest = await $arcgis.import("@arcgis/core/request.js");


      });
Expand

Create a variable called url and set its value as the portal service URL, e.g. https://arcgis.com/sharing/rest/content/users/<USER_NAME>/items/<ITEM_ID>/share. Replace <USER_NAME> with your username and <ITEM_ID> with the item ID you copied in the previous step.

Expand
Use dark colors for code blocks
       const esriRequest = await $arcgis.import("@arcgis/core/request.js");


         const url = "https://arcgis.com/sharing/rest/content/users/<USER_NAME>/items/<ITEM_ID>/share"

      });
Expand

Create an object called options and define your search parameters. Pass in your access token into the token field and set everyone to true. This will set the sharing level of your item to public. To see other sharing levels, go to Sharing items.

Expand
Use dark colors for code blocks
       const esriRequest = await $arcgis.import("@arcgis/core/request.js");


         const url = "https://arcgis.com/sharing/rest/content/users/<USER_NAME>/items/<ITEM_ID>/share"

         const options = {
           query: {
             f: "pjson",
             everyone: "true",
             token: "YOUR_ACCESS_TOKEN"
           }
         };

      });
Expand

Execute the POST call and print the JSON response.

Expand
Use dark colors for code blocks
       const esriRequest = await $arcgis.import("@arcgis/core/request.js");


         const url = "https://arcgis.com/sharing/rest/content/users/<USER_NAME>/items/<ITEM_ID>/share"

         const options = {
           query: {
             f: "pjson",
             everyone: "true",
             token: "YOUR_ACCESS_TOKEN"
           }
         };

         esriRequest(url, {
           method: "post",
           ...options
         }).then((response) => {
           const data = response.data;
           console.log(data);
         });

      });
Expand

View the results

Go back to your portal and you should see that the sharing level of your item has changed to public. Your code may also print an output like this to verify that the operation was successful:

Use dark colors for code blocksCopy
{
    "notSharedWith": [],
    "itemId": "<ITEM_ID>"
}

What's next

Copy a hosted layer item

Use the portal service to copy a hosted layer item in your portal.

ArcGIS Location PlatformArcGIS OnlineArcGIS EnterprisePython APIREST API

Create a new group and add members

Use the portal service to create a new group and add members in your portal.

ArcGIS Location PlatformArcGIS OnlineArcGIS EnterprisePython APIREST JS