DocumentationAPI ReferenceRelease Notes
API Reference

Update user

Update an existing user's profile information and settings.

Required Permission(s)

  • User Accounts Management (Full control)

Notes

  • Cannot update ActiveDirectory or LDAP users
  • For Pathfinder users only: Restrict to application type users only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The unique integer identifier of the user to update

Body Params

The updated user information including profile and security settings

Request body for PUT Users/{id} (update) and POST UserGroups/{userGroupID}/Users (create in group).
Only BeyondInsight and Application user types can be updated; ActiveDirectory, EntraID, and LDAP users cannot be modified.
Fields honored by the API (all except Password and AccessPolicyID are inherited from UserModel):
UserName, FirstName, LastName, EmailAddress are applied to both BeyondInsight and Application users.
Password is applied to both types (complexity checks are enforced for BeyondInsight users; skipped for Application users).
AccessPolicyID is applied only when updating existing Application users (ignored on create and for BeyondInsight users).
UserType: on update, the client-supplied value is ignored (overwritten with the existing user's type); on create, parsed during validation but not persisted.
IsQuarantined and IsActive are not mapped by these endpoints and will be ignored if provided.
DomainName is used for duplicate username detection but not persisted. DistinguishedName is not used.

int32

The access policy ID (Application users only; ignored for BeyondInsight users and on create). When updating an existing Application user, if provided and greater than 0, updates the user's access policy; otherwise ignored

string | null

The distinguished name

string | null

The domain name

string | null

The user's email address

string | null

The user's first name

boolean

The user's activity status

boolean

The user's quarantine status

string | null

The user's last name

string | null

User password. Required (non-null, non-whitespace) when creating users via create-in-group; optional when updating—if provided (non-null, non-whitespace string), replaces the existing password (complexity checks enforced for BeyondInsight users; skipped for Application users); if omitted, null, or empty string, the existing password remains unchanged; whitespace-only values are rejected

int32

The ID of the user

string | null

The user name

string | null

The user type

Headers
string
enum
Defaults to application/*+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.