Update user

put

https://example.com/beyondtrust/api/public/v3/users/{id}

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

The unique integer identifier of the user to update

Body Params

The updated user information including profile and security settings

Password

string | null

Password value which will update the existing password

AccessPolicyID

int32

The access policy ID for this request

UserID

int32

The ID of the user

UserType

string | null

The user type

UserName

string | null

The user name

DomainName

string | null

The domain name

DistinguishedName

string | null

The distinguished name

FirstName

string | null

The user's first name

LastName

string | null

The user's last name

EmailAddress

string | null

The user's email address

IsQuarantined

boolean

The user's quarantine status

IsActive

boolean

The user's activity status

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200User updated successfully

400Invalid user data or validation errors

403Insufficient permissions to update this user

404User not found