updateUser
FunctionupdateUser(requestOptions?: IUpdateUserOptions): Promise<IUpdateUserResponse>
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.
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" }
Parameters
Parameter | Type | Notes |
---|---|---|
request | IUpdateUserOptions | options to pass through in the request |
Returns
Promise<IUpdateUserResponse>
A Promise that will resolve with metadata about the user