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 REST JSArcGIS API for JavaScriptArcGIS API for Python
Use dark colors for code blocksCopy
             
1
2
3
4
5
6
7
8
9
10
11
12
13
import { request } from "@esri/arcgis-rest-request"
import { ArcGISIdentityManager } from '@esri/arcgis-rest-request'

ArcGISIdentityManager.fromToken({
  token: "ACCESS_TOKEN", //Token representing an ArcGIS Identity from performing oAuth 2.0
}).then((authentication) => {
  request("https://www.arcgis.com/sharing/rest/community/users", {
    authentication: authentication,
    params: { q: "JSmith" },
  });
}).then((response) => {
  console.log(response);
});

REST API

cURLcURLHTTP
Use dark colors for code blocksCopy
    
1
2
3
4
curl https://www.arcgis.com/sharing/rest/community/users \
-d 'q=JSmith' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

Get a user

Find a user with their username.

APIs

ArcGIS REST JSArcGIS REST JSArcGIS API for JavaScriptArcGIS API for Python
Use dark colors for code blocksCopy
      
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

cURLcURLHTTP
Use dark colors for code blocksCopy
  
1
2
curl https://www.arcgis.com/sharing/rest/community/users/jsmith \
-d 'f=pjson'

Update user information

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

APIs

ArcGIS REST JSArcGIS REST JSArcGIS API for Python
Use dark colors for code blocksCopy
              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { updateUser } from '@esri/arcgis-rest-portal'
import { ArcGISIdentityManager } from '@esri/arcgis-rest-request'

ArcGISIdentityManager.fromToken({
  token: "ACCESS_TOKEN", //Token representing an ArcGIS Identity from performing oAuth 2.0
}).then((authentication) => {
  return 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

cURLcURLHTTP
Use dark colors for code blocksCopy
     
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>'

Get invitation status

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

APIs

ArcGIS REST JSArcGIS REST JSArcGIS API for Python
Use dark colors for code blocksCopy
               
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import { getUserInvitation } from '@esri/arcgis-rest-portal'
import { ArcGISIdentityManager } from '@esri/arcgis-rest-request'

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

REST API

cURLcURLHTTP
Use dark colors for code blocksCopy
   
1
2
3
curl https://www.arcgis.com/sharing/rest/community/users/<USERNAME>/invitations/<INVITATION_ID> \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

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, use HTTP requests.
  • 2. Access via 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.