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:

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

Examples

Search for a user

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

APIs

ArcGIS REST JS

ArcGIS JS API

ArcGIS Python API

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

Request

Response

curl https://www.arcgis.com/sharing/rest/community/users \
-d 'q=Jsmith' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

{
  "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 JS

ArcGIS JS API

ArcGIS Python API

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

Request

Response

curl https://www.arcgis.com/sharing/rest/community/users/jsmith \
-d 'f=pjson'

{
  "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 JS

ArcGIS Python API

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

Request

Response

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>'

{
  "success": true
}

Get invitation status

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

APIs

ArcGIS REST JS

ArcGIS Python API

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

Request

Response

curl https://www.arcgis.com/sharing/rest/community/users/<USERNAME>/invitations/<INVITATION_ID> \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

{
  "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

Create a web map

Use Map Viewer to create a web map for your application.

Style layers in a web map

Use Map Viewer to style layers in a web map.

Display a web map

Create and display a map from a web map.

Web scenes

Create a web scene

Use Scene Viewer to create a web scene for your application.

Style layers in a web scene

Use Scene Viewer to style layers in a web scene.

Display a web scene

Create and display a scene from a web scene.

Feature layers

Import data as a feature layer

Use data management tools to import and create hosted feature layers.

Manage a feature layer

Set the properties and capabilities of a hosted feature layer.

Add a feature layer

Access and display point, line, and polygon features from a feature service

Vector tile layers

Publish a vector tile layer

Use ArcGIS Online to publish a vector tile layer.

Add a vector tile layer

Access and display a vector tile layer in a map.

Basemap layers

Create a custom basemap style

Use the Vector tile style editor to style a vector tile basemap layer.

Display a custom basemap style

Add and display a styled vector tile basemap layer.

Services

Portal service

Store, manage, and access private and public content.

API support

	Search	Items	Users	Groups
ArcGIS API for JavaScript			¹	¹
ArcGIS Runtime API for Android			¹	¹
ArcGIS Runtime API for iOS			¹	¹
ArcGIS Runtime API for Java			¹	¹
ArcGIS Runtime API for .NET			¹	¹
ArcGIS Runtime API for Qt			¹	¹
ArcGIS API for Python
Esri Leaflet	²	²	²	²
MapBox GL JS	²	²	²	²
OpenLayers	²	²	²	²
ArcGIS REST JS

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.

Developer dashboard

Manage API keys, service usage, and data with the ArcGIS Developers website.

ArcGIS Online

Create, manage, and share content and data with cloud-based GIS tools.

Map Viewer

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

Scene Viewer

Create, explore, and share web scenes for 3D applications.

Vector tile style editor

Style vector tile basemap layers for applications.

ArcGIS Pro

Explore, visualize, and analyze both 2D and 3D data with desktop GIS tools.

PreviousSearch NextGroups

DocumentationMapping APIs and services

Users

Was this page helpful?

Was this page helpful?