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 JSArcGIS REST JSArcGIS API for JavaScriptArcGIS API for Python
Use dark colors for code blocksCopy
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);
});
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/users \
-d 'q=JSmith' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

View in Postman

Use dark colors for code blocksCopy
{
  "query": "JSmith",
  "total": 189,
  "start": 1,
  "num": 10,
  "nextStart": 11,
  "results": [
    {
      "username": "OntarioAdmin",
      "id": "08c59cc53ae5c2ad7532549808521e4f",

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
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);
  });
Go to API reference

REST API

cURL

HTTP

Use dark colors for code blocks

Copy

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

View in Postman

Use dark colors for code blocksCopy
{
  "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 REST JSArcGIS API for Python
Use dark colors for code blocksCopy
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);
});
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/users/<USERNAME>/update \
-d 'username=<USERNAME>'
-d 'description=A new description of user ' \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

View in Postman

Use dark colors for code blocksCopy
{
  "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 REST JSArcGIS API for Python
Use dark colors for code blocksCopy
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);
});
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/users/<USERNAME>/invitations/<INVITATION_ID> \
-d 'f=pjson' \
-d 'token=<ACCESS_TOKEN>'

View in Postman

Use dark colors for code blocksCopy
{{
  "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	²	²	²	²
MapLibre GL JS	²	²	²	²
OpenLayers	²	²	²	²
ArcGIS REST JS

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.

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.

Mapping APIs and location services

Users

Was this page helpful?

Was this page helpful?