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

Update a user profile. The username will be extracted from the authentication session unless it is provided explicitly. See the REST Documentation for more information.


Parameter Type Default Notes
requestOptions Optional IUpdateUserOptions

options to pass through in the request

Available requestOptions

Property Type Notes
user IUser

The user properties to be updated.

authentication Inherited UserSession

A session representing a logged in user.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response


A Promise that will resolve with metadata about the user

Property Type Notes
success boolean
username string

Function defined in packages/arcgis-rest-portal/src/users/update.ts:45