Manage groups

You can use the portal service to access and manage groups in an organization. A group is a container for items available to a specific set of users in the portal.

Available groups displayed in Groups section in an organization in ArcGIS portal

Working with groups

Groups are used to organize and share items and define which users can access and view specified content. You can create groups of hosted layers, web maps, or any other item type. Or you can create a group and add users to it, allowing them to collaborate and share items within the group.

The typical workflow for using groups is to:

Define a group in the portal.
Add items the group.
Add users to the group.
Manage the group properties.

Code examples

Search for a group

Find a one or more groups in the portal using a query.

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Expand
Use dark colors for code blocksCopy
        portal = new Portal(); // Default is "https://www.arcgis.com/sharing/rest"
        portal.load().then(()=>{
        const query = {
          query: "water"
        };
        portal.queryGroups(query).then((response)=>{
          console.log(response);
        });
      });
Expand
Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
curl https://www.arcgis.com/sharing/rest/community/groups \
-d 'q=water' \
-d 'f=pjson'

Run in Postman

Use dark colors for code blocksCopy
{
  "query": "water",
  "total": 3206,
  "start": 1,
  "num": 10,
  "nextStart": 11,
  "results": [
    {
      "id": "b2e2fce2ab304ff38c27b811b1784b23",
      "title": "Wyoming WRDS WDO - Water",

Create a new group

Define a new group and how it can be accessed.

APIs

ArcGIS API for Python

ArcGIS REST JS

Use dark colors for code blocks

Copy

1
2
3
4
from arcgis.gis import GIS
gis = GIS(username="USERNAME", password="PASSWORD")
group = gis.groups.create(title="Traffic issues", tags="traffic", access="public")
print(group)

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
5
curl https://www.arcgis.com/sharing/rest/community/createGroup \
-d 'title=Traffic issues' \
-d 'access=public' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Run in Postman

Use dark colors for code blocksCopy
{    "success": true,
  "group": {
    "id": "GROUP_ID",
    "title": "Traffic issues",
    "access": "public"
    }
  }

Invite users to a group

Invite users by their user names.

APIs

ArcGIS API for Python

ArcGIS REST JS

Use dark colors for code blocks

Copy

1
2
3
4
5
from arcgis.gis import GIS
gis = GIS(username="USERNAME", password="PASSWORD")
group = gis.groups.get("GROUP_ID")
results = group.invite_users(usernames=["USER_TO_INVITE"])
print(results)

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
5
6
curl  https://www.arcgis.com/sharing/rest/community/groups/<GROUP_ID>/invite \
-d 'users=<USER_TO_INVITE>' \
-d 'role=group member' \
-d 'expiration=20160' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Run in Postman

Use dark colors for code blocksCopy
{
  "success":true,
  "groupId": "GROUP_ID"
}

Add items to a group

Add an item to group to be shared with a set of users.

APIs

ArcGIS API for Python

ArcGIS REST JS

Use dark colors for code blocks

Copy

1
2
3
4
5
from arcgis.gis import GIS
gis = GIS(username="USERNAME", password="PASSWORD")
item = gis.content.get("ITEM_ID")
results = item.share(groups="GROUP_ID")
print(results)

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
curl  https://www.arcgis.com/sharing/rest/content/users/<USERNAME>/items/<ITEM_ID>/share \
-d 'f=json' \
-d 'groups=<GROUP_ID>' \
-d 'token=<ACCESS_TOKEN>'

Run in Postman

Use dark colors for code blocksCopy
{"results": [{"itemId": "ITEM_ID",
  "success": true,
  "notSharedWith": []}]} // Groups item not shared with

Search for group content

Find items shared with a group using a query.

APIs

ArcGIS Maps SDK for JavaScript

ArcGIS API for Python

ArcGIS REST JS

Expand
Use dark colors for code blocksCopy
        const portal = new Portal();
        portal.url = "https://www.arcgis.com/"
        portal.load()
          .then(()=> {

          const portalGroup = new PortalGroup({
            id: "d6340748701d4ccfb18ad3c42b7feb9e",
            portal: portal
          });
          const queryParameters = {
            query: "bike"
          };

          portalGroup.queryItems(queryParameters).then((response)=>{
            console.log(response);
          });
        });
Expand
Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
curl  https://www.arcgis.com/sharing/rest/content/groups/d6340748701d4ccfb18ad3c42b7feb9e/search \
-d 'q=bike' \
-d 'f=pjson'

Run in Postman

Use dark colors for code blocksCopy
{
  "query": "bike",
  "total": 2,
  "start": 1,
  "num": 10,
  "nextStart": -1,
  "results": [
    {
      "id": "37695c689cbe4e87aa1877ef12c7bf3b",
      "owner": "esri_devlabs",

Update properties

Change the properties of a group such as the name, description, and permissions.

APIs

ArcGIS API for Python

ArcGIS REST JS

Use dark colors for code blocks

Copy

1
2
3
4
5
6
from arcgis.gis import GIS

gis = GIS(username="USERNAME", password="PASSWORD")
group = gis.groups.get("GROUP_ID")
results = group.update("new")  # new title
print(results)

Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

1
2
3
4
curl  https://www.arcgis.com/sharing/rest/community/groups/GROUP_ID/update \
-d 'title=new' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Run in Postman

Use dark colors for code blocksCopy
{
  "success": "true",
  "groupId": "GROUP_ID"
}

Services

Portal service

Store, manage, and access private and public content.

API support

	Search	Items	Users	Groups	Settings	Security
ArcGIS Maps SDK for JavaScript			¹	¹	¹	¹
ArcGIS Maps SDK for .NET			¹	¹	¹	¹
ArcGIS Maps SDK for Kotlin			¹	¹	¹	¹
ArcGIS Maps SDK for Swift			¹	¹	¹	¹
ArcGIS Maps SDK for Java			¹	¹	¹	¹
ArcGIS Maps SDK for Qt			¹	¹	¹	¹
ArcGIS API for Python
ArcGIS REST JS
Esri Leaflet	²	²	²	²	²	²
MapLibre GL JS	²	²	²	²	²	²
OpenLayers	²	²	²	²	²	²

Full supportPartial supportNo support

1. Limited operations, use HTTP requests.
2. Access via ArcGIS REST JS.

Tools

Use tools to access the portal and create and manage content for applications.

ArcGIS Enterprise

Create, manage, analyze, and share data, maps, and applications in your organization.

Portal

Create, manage, and access content and data services for applications.

Map Viewer

Create, explore, and share web maps for 2D applications.

Scene Viewer

Create, style, and explore web scenes.

Vector Tile Style Editor

Create styles for basemap and vector tile layers.

Content management tools

Create, manage, organize, and share items in a portal.

Data management tools

Import data and create hosted layers and data services. Upload and manage documents, images, and other files.

Spatial analysis tools

Perform feature and raster analysis to create new datasets with the Map Viewer.

Developer credentials tool

Create API key and OAuth 2.0 developer credentials for custom applications.

Items

Manage and share items.

ArcGIS Pro

Create, style, and explore maps and scenes.

Geoprocessing tools

Import, manage, and analyze data.