Users

A user is an identity with a set of privileges used to access a portal.

Working with users

A user is created when an account is created for a user or when someone signs up to join an organization. When they join, an identity and a role are assigned. A role defines the set of privileges and operations that the user can perform within the organization.

You 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 a portal.
Search for users.
Assign users to groups.
Manage user properties.

Examples

The following examples use ArcGIS REST JS to search the ArcGIS Online portal. To access a different portal, specify the portal URL.

Search for a user

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

import { searchItems } from "@esri/arcgis-rest-portal";
// Search for a user wiht text
searchUsers({ q: 'tommy', authentication })
  .then(response) // response.total

Get a user

Find a user with their username.

import { getUser } from '@esri/arcgis-rest-portal';
// Find a user name
getUser("jsmith")
  .then(response)
// => { firstName: "John", lastName: "Smith",tags: ["GIS Analyst", "City of Redlands"] }

Update user information

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

import { updateUser } from '@esri/arcgis-rest-portal';
// any user can update their own profile
updateUser({
  authentication,
  user: { description: "better than the last one" }
})
  .then(response)
// org administrators must declare the username that will be updated explicitly
updateUser({
  authentication,
  user: { username: "c@sey", description: "" }
})
  .then(response)
// => { "success": true, "username": "c@sey" }

Get invitation status

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

import { getUserInvitation } from '@esri/arcgis-rest-portal';
// username is inferred from UserSession
getUserInvitation({
  invitationId: "3ef",
  authentication
})
  .then(response) // => response.accepted => true