Create a new group and add members

https://developers.arcgis.com/arcgis-rest-js/install/

https://developers.arcgis.com/python/guide/anaconda/

https://developers.arcgis.com/javascript/latest/install-and-set-up/

1. Add the following import statement to your code.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   
   from arcgis.gis import GIS
   
   

2. Establish a connection to the portal using the GIS() module.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   
   from arcgis.gis import GIS
   
   # Authenticate with your ArcGIS Online account
   gis = GIS("https://www.arcgis.com", "your_username", "your_password")
   
   

3. Create a dictionary of the new group and add it using the create_from_dict method.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   
   from arcgis.gis import GIS
   
   # Authenticate with your ArcGIS Online account
   gis = GIS("https://www.arcgis.com", "your_username", "your_password")
   
   # Create a group
   group_properties = {
       "title": "Example Group",
       "description": "This is an example group",
       "tags": "example, group, arcgis python",
       "snippet": "Example group",
       "access": "public"  # Can be 'private', 'org', or 'public'
   }
   
   group = gis.groups.create_from_dict(group_properties)
   print(f"Group created: {group.title}")
   
   

4. Add existing members to the new group using the add_users method.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   
   from arcgis.gis import GIS
   
   # Authenticate with your ArcGIS Online account
   gis = GIS("https://www.arcgis.com", "your_username", "your_password")
   
   # Create a group
   group_properties = {
       "title": "Example Group",
       "description": "This is an example group",
       "tags": "example, group, arcgis python",
       "snippet": "Example group",
       "access": "public"  # Can be 'private', 'org', or 'public'
   }
   
   group = gis.groups.create_from_dict(group_properties)
   print(f"Group created: {group.title}")
   
   # Add an existing member to the group
   usernames_to_add = ["member_username1", "member_username2"]
   result = group.add_users(usernames_to_add)
   
   

5. Verify members were added to the group.

   main.py

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   
   from arcgis.gis import GIS
   
   # Authenticate with your ArcGIS Online account
   gis = GIS("https://www.arcgis.com", "your_username", "your_password")
   
   # Create a group
   group_properties = {
       "title": "Example Group",
       "description": "This is an example group",
       "tags": "example, group, arcgis python",
       "snippet": "Example group",
       "access": "public"  # Can be 'private', 'org', or 'public'
   }
   
   group = gis.groups.create_from_dict(group_properties)
   print(f"Group created: {group.title}")
   
   # Add an existing member to the group
   usernames_to_add = ["member_username1", "member_username2"]
   result = group.add_users(usernames_to_add)
   
   if 'notAdded' in result and result['notAdded']:
       print(f"Failed to add user(s): {result['notAdded']}")
   else:
       print(f"Users added successfully to the group {group.title}")

1. Add the following import statement to your code.

   rest-js.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   
   import { ApiKeyManager } from '@esri/arcgis-rest-request';
   import { createGroup, addGroupUsers } from '@esri/arcgis-rest-portal';
   
   

2. Create a user session using your credentials

   rest-js.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   
   import { ApiKeyManager } from '@esri/arcgis-rest-request';
   import { createGroup, addGroupUsers } from '@esri/arcgis-rest-portal';
   
   const apiKey = "YOUR_ACCESS_TOKEN";
   const authentication = ApiKeyManager.fromKey(apiKey);
   
   

3. Create a new group

   rest-js.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   
   import { ApiKeyManager } from '@esri/arcgis-rest-request';
   import { createGroup, addGroupUsers } from '@esri/arcgis-rest-portal';
   
   const apiKey = "YOUR_ACCESS_TOKEN";
   const authentication = ApiKeyManager.fromKey(apiKey);
   
   // Create a new group
   const createGroupResponse = await createGroup({
     title: 'New Group Title',
     description: 'Description of the new group',
     access: 'public', // other options are 'org' and 'private'
     authentication,
   });
   
   

4. Add exiting members to the new group

   rest-js.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   
   import { ApiKeyManager } from '@esri/arcgis-rest-request';
   import { createGroup, addGroupUsers } from '@esri/arcgis-rest-portal';
   
   const apiKey = "YOUR_ACCESS_TOKEN";
   const authentication = ApiKeyManager.fromKey(apiKey);
   
   // Create a new group
   const createGroupResponse = await createGroup({
     title: 'New Group Title',
     description: 'Description of the new group',
     access: 'public', // other options are 'org' and 'private'
     authentication,
   });
   
   if (createGroupResponse.success) {
     const groupId = createGroupResponse.group.id;
     console.log(`Group created successfully with ID: ${groupId}`);
   
     // Add existing members to the newly created group
     const usernameToAdd = ['existing_member_username1', 'existing_member_username2'];
     const addGroupUsersResponse = await addGroupUsers({
       id: groupId,
       users: usernameToAdd,
       authentication,
     });
   
   

5. Verify members was added to the group

   rest-js.js

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   
   import { ApiKeyManager } from '@esri/arcgis-rest-request';
   import { createGroup, addGroupUsers } from '@esri/arcgis-rest-portal';
   
   const apiKey = "YOUR_ACCESS_TOKEN";
   const authentication = ApiKeyManager.fromKey(apiKey);
   
   // Create a new group
   const createGroupResponse = await createGroup({
     title: 'New Group Title',
     description: 'Description of the new group',
     access: 'public', // other options are 'org' and 'private'
     authentication,
   });
   
   if (createGroupResponse.success) {
     const groupId = createGroupResponse.group.id;
     console.log(`Group created successfully with ID: ${groupId}`);
   
     // Add existing members to the newly created group
     const usernameToAdd = ['existing_member_username1', 'existing_member_username2'];
     const addGroupUsersResponse = await addGroupUsers({
       id: groupId,
       users: usernameToAdd,
       authentication,
     });
   
     if (addGroupUsersResponse.notAdded.length === 0) {
       console.log(`Users added to the group successfully.`);
     } else {
       console.log(`Failed to add users to the group.`);
       console.log('Details:', addGroupUsersResponse.notAdded);
     }