Users

A user is a stored identity that represents a registered user of the portal.

Working with users

A user is created when someone signs up for a developer account, when an account is created for a user by an administrator, or when someone joins an organization. When an account is created, an identity and a role are assigned. The role defines the set of privileges and operations that the user can perform within the organization associated with the account.

Administrators can also use data management tools and ArcGIS REST API to create and manage users. Only an administrator or the owner of a user's account can make updates to users within an organization.

The typical way to work with users is to:

  1. Invite users or create new users in the portal.
  2. Search for users.
  3. Assign users to groups.
  4. Manage user properties.

Examples

Search for a user

Use a query to search users by name, description, and other information.

APIs

ArcGIS REST JSArcGIS JS APIArcGIS Python API
             
1
2
3
4
5
6
7
8
9
10
11
12
13
import { request } from "@esri/arcgis-rest-request"
import { UserSession } from "@esri/arcgis-rest-auth"

const authentication = new UserSession({ // ArcGIS account credentials
  token: "ACCESS_TOKEN" //Token representing an ArcGIS Identity from performing oAuth 2.0
});

request("https://www.arcgis.com/sharing/rest/community/users", {
  authentication: authentication,
  params: { q: "JSmith"}
}).then((response)=>{
  console.log(response);
});

REST API

RequestResponse
    
1
2
3
4
curl https://www.arcgis.com/sharing/rest/community/users \
-d 'q=Jsmith' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'
                                                                                                                                                                                                                 
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
{
  "query": "JSmith",
  "total": 189,
  "start": 1,
  "num": 10,
  "nextStart": 11,
  "results": [
    {
      "username": "OntarioAdmin",
      "id": "08c59cc53ae5c2ad7532549808521e4f",
      "fullName": "Jim Smith",
      "firstName": "Jim",
      "lastName": "Smith",
      "description": "Jim Smith | GIS Coorindator&#10;&#13;&#10;&#13;Ministry of Transportation | 301 St. Paul Street | St. Catharines, ON L2R  7R4&#10;&#13;&#10;&#13;T 416-386-6481&#10;&#13;M 416-209-0489&#10;&#13;E jsmith@ontario.ca&#10;&#13;   ",
      "tags": [
        "undefined"
      ],
      "culture": "en",
      "cultureFormat": null,
      "region": "CA",
      "units": null,
      "thumbnail": "photo.JPG",
      "access": "public",
      "created": 1316617421000,
      "modified": 1492275854000,
      "provider": null
    },
    {
      "username": "jsmith0318",
      "id": "028ae9834fa4f319a55d133ca672ba44",
      "fullName": "John Smith",
      "firstName": "John",
      "lastName": "Smith",
      "description": "I have worked for Government for more than 33 years in both the State and Local systems.  Of those 33 years, 24 of those were using GIS in a variety of ways.  My GIS career started with a PC ArcInfo system using SML scripting (anybody remember that?) which we quickly grew out of.  Then it was on to a Sun Unix system using \"real\" GIS and AML.  That was a few years ago.  My latest version of the software was the ArcGIS for Desktop, version 10.2.2.  I have seen a lot of changes over the years and can only say that ESRI is continually making it better and better!  Now I am retired from the City of Salem (and my GIS career), but wanted to share some of my adventures with whomever is interested.  The first adventure is a bicycle tour across the United States from Jefferson, Oregon (where I live) to Portland, Maine - 3733 miles (according to GIS!).  So many people have asked if I will be blogging, so I thought I'd do one better - blod AND map my ride.  So this is the \"map\" part for those who want to see the route and follow my progress the summer and fall of 2014.  Since I love GIS so much, and will miss it tremendously, I decided to set up this account to keep up with the technology and let others know what's happening.  I hope to continue to use GIS in the future as a Red Cross volunteer and anywhere else my skills can be used.",
      "tags": [

      ],
      "culture": "en",
      "cultureFormat": null,
      "region": "US",
      "units": null,
      "thumbnail": "John.jpg",
      "access": "public",
      "created": 1403535158000,
      "modified": 1515456706000,
      "provider": null
    },
    {
      "username": "jsmith_retired",
      "id": "5593b70b5971083c1390234104da8085",
      "fullName": "John Smith",
      "firstName": "John",
      "lastName": "Smith",
      "description": "After more than 33 years in Oregon State and Local Government, and more than 24 of those years using ArcInfo and ArcGIS products, I decided to call it quits and retire.  Now I am planning retirement activities that include bicycle touring and I fully intend to use the ArcGIS products to plan and advertise my trips.",
      "tags": [

      ],
      "culture": "en",
      "cultureFormat": null,
      "region": "US",
      "units": null,
      "thumbnail": "John_Retired_2.jpg",
      "access": "public",
      "created": 1421108929000,
      "modified": 1421109443000,
      "provider": null
    },
    {
      "username": "jsmith_nifc",
      "id": "276974a9adc7f6e29a1890037ab00750",
      "fullName": "S 3 - Jordan Smith (GIS Lead)",
      "firstName": "S 3 - Jordan",
      "lastName": "Smith (GIS Lead)",
      "description": "Work for the Texas A&M Forest Service Emergency Operations Center also on the Lone Star State Incident Management Team.",
      "tags": [

      ],
      "culture": "en",
      "cultureFormat": null,
      "region": "WO",
      "units": null,
      "thumbnail": "TFS_RGB-maroon_gray_STAR.jpg",
      "access": "public",
      "created": 1465499018000,
      "modified": 1590675201000,
      "provider": null
    },
    {
      "username": "jsmith26_EPA",
      "id": "f0c2355777dd7dcc9083e0e8cd6cd03b",
      "fullName": "Jason Smith",
      "firstName": "Jason",
      "lastName": "Smith",
      "description": "Works as an Environmental Scientist/GIS Analyst for the Office of Air Quality Planning and Standards, within the Office of Air and Radiation at US EPA.",
      "tags": [

      ],
      "culture": "en-US",
      "cultureFormat": null,
      "region": "WO",
      "units": null,
      "thumbnail": "Selfie1.jpg",
      "access": "public",
      "created": 1423173441000,
      "modified": 1616766048000,
      "provider": null
    },
    {
      "username": "jsmith119",
      "id": "fdead220d708dd9edfd5253eec28b777",
      "fullName": "James Smith",
      "firstName": "James",
      "lastName": "Smith",
      "description": "Graduate Student @ Murray State University ",
      "tags": [
        "undefined"
      ],
      "culture": null,
      "cultureFormat": null,
      "region": null,
      "units": null,
      "thumbnail": null,
      "access": "public",
      "created": 1351535814000,
      "modified": 1405751856000,
      "provider": null
    },
    {
      "username": "jsmith@mema.ms.gov",
      "id": "271bcf756dd0ffb553d2a0c3eca14d2c",
      "fullName": "Jefferson smith",
      "firstName": "Jefferson",
      "lastName": "smith",
      "description": "organization - Mississippi Emergency Management Agency",
      "tags": [

      ],
      "culture": "en",
      "cultureFormat": null,
      "region": "US",
      "units": null,
      "thumbnail": null,
      "access": "public",
      "created": 1392771636000,
      "modified": 1411418538000,
      "provider": null
    },
    {
      "username": "Jsmith@lansdale.org",
      "id": "7b2c25acf102040517e4f2695ba579a5",
      "fullName": "Justin Smith",
      "firstName": "Justin",
      "lastName": "Smith",
      "description": null,
      "tags": [
        "undefined"
      ],
      "culture": "en-US",
      "cultureFormat": null,
      "region": "US",
      "units": null,
      "thumbnail": "Photo.png",
      "access": "public",
      "created": 1369944437000,
      "modified": 1604583802000,
      "provider": null
    },
    {
      "username": "jsmith7124",
      "id": "ee1b344e34b76c0d02208085c08ead88",
      "fullName": "Jaime Smith",
      "firstName": "Jaime",
      "lastName": "Smith",
      "description": null,
      "tags": [
        "undefined"
      ],
      "culture": null,
      "cultureFormat": null,
      "region": null,
      "units": null,
      "thumbnail": "black-panther-meiklejohn.jpg",
      "access": "public",
      "created": 1313510495000,
      "modified": 1313510543000,
      "provider": null
    },
    {
      "username": "jsmith331",
      "id": "14b80e09eaa24a777afa7fbbfb626723",
      "fullName": "John Smith",
      "firstName": "John",
      "lastName": "Smith",
      "description": null,
      "tags": [

      ],
      "culture": null,
      "cultureFormat": null,
      "region": null,
      "units": null,
      "thumbnail": "geographer-vermeer.jpg",
      "access": "public",
      "created": 1514318006000,
      "modified": 1547209362000,
      "provider": null
    }
  ]
}

Get a user

Find a user with their username.

APIs

ArcGIS REST JSArcGIS JS APIArcGIS Python API
      
1
2
3
4
5
6
import { getUser } from '@esri/arcgis-rest-portal'
// Find a user name
getUser("jsmith", { portal: "https://www.arcgis.com/sharing/rest" })
  .then((response)=>{
    console.log(response);
  });

REST API

RequestResponse
  
1
2
curl https://www.arcgis.com/sharing/rest/community/users/jsmith \
-d 'f=pjson'
          
1
2
3
4
5
6
7
8
9
10
{
  "username": "JSmith",
  "id": "b46f4fffc4694c238862d69b39e1db33",
  "fullName": "",
  "firstName": "",
  "lastName": "",
  "created": 1556719488000,
  "modified": 1571230751000,
  "provider": "arcgis"
}

Update user information

Update user profile information such as their role or credits assigned.

APIs

ArcGIS REST JSArcGIS Python API
              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { updateUser } from '@esri/arcgis-rest-portal'
import { UserSession } from '@esri/arcgis-rest-auth'

const authentication = new UserSession({
  token: "ACCESS_TOKEN" //Token representing an ArcGIS Identity from performing oAuth 2.0
});
updateUser({
  authentication: authentication,
  user: { username: "USERNAME", description: "A new description of user"}, // Your username, or another in your org (if admin)
  portal: "https://www.arcgis.com/sharing/rest"
})
  .then((response)=>{
    console.log(response);
  });

REST API

RequestResponse
     
1
2
3
4
5
curl https://www.arcgis.com/sharing/rest/community/users/<USERNAME>/update \
-d 'username=<USERNAME>'
-d 'description=A new description of user ' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'
   
1
2
3
{
  "success": true
}

Get invitation status

Find the status of an invitation that was sent to a user to join the portal.

APIs

ArcGIS REST JSArcGIS Python API
              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { getUserInvitation } from '@esri/arcgis-rest-portal'
import { UserSession } from '@esri/arcgis-rest-auth'

const authentication = new UserSession({
  token: "ACCESS_TOKEN" //Token representing an ArcGIS Identity from performing oAuth 2.0
});
getUserInvitation({ // Username inferred from UserSession
  invitationId: "INVITATION_ID",
  authentication: authentication,
  portal: "https://www.arcgis.com/sharing/rest"
})
  .then((response)=>{
    console.log(response);
  });

REST API

RequestResponse
   
1
2
3
curl https://www.arcgis.com/sharing/rest/community/users/<USERNAME>/invitations/<INVITATION_ID> \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'
                                                       
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
  "id": "INVITATION-ID",
  "targetType": "group",
  "targetId": "GROUP_ID",
  "received": "DATE-RECEIVED",
  "accepted": false,
  "mustApprove": false,
  "email": null,
  "role": "group-member",
  "type": "user",
  "dateAccepted": -1,
  "expiration": 1614711430000,
  "created": "DATE-RECEIVED",
  "username": "USERNAME",
  "fromUsername": {
    "username": "",
    "fullname": ""
  },
  "group": {
    "id": "GROUP_ID",
    "title": "title",
    "isInvitationOnly": true,
    "owner": "GROUP_OWNER",
    "description": "GROUP_DESCRIPTION",
    "snippet": null,
    "tags": [

    ],
    "typeKeywords": [

    ],
    "phone": null,
    "sortField": "title",
    "sortOrder": "asc",
    "isViewOnly": false,
    "thumbnail": null,
    "created": 1612987767000,
    "modified": 1613758035000,
    "access": "public",
    "capabilities": [

    ],
    "isFav": false,
    "isReadOnly": false,
    "protected": false,
    "autoJoin": false,
    "notificationsEnabled": false,
    "provider": null,
    "providerGroupName": null,
    "leavingDisallowed": false,
    "hiddenMembers": false,
    "displaySettings": {
      "itemTypes": ""
    }
  }

Tutorials

Use tools to create different types of content and build content-driven applications.

Web maps

Web scenes

Feature layers

Vector tile layers

Basemap layers

Services

Portal service

Store, manage, and access private and public content.

API support

Full supportPartial supportNo support
  • 1. Limited operations
  • 2. Requires ArcGIS REST JS

Tools

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.