Update User

Update a user in Tenable Vulnerability Management.

Input

Field	Definition	Type	Required
Update By
ID or UUID	The unique identifier of the user. Both UUID and ID are accepted. Example UUID input: `a1ac5e57-d3cf-4396-a825-38538bc52d26` Example ID input: `2192886`	Text	TRUE
User
Full Name	The full name of the user.	Text	FALSE
Email	The email address of the user. A valid email address must be in the `name@domain` format where domain corresponds to a domain approved for your Tenable Vulnerability Management instance. Admins can create users with an email address that has a domain outside of the approved domains. This email address overrides the email address set in username. If your request omits this parameter, Tenable Vulnerability Management uses the username value as the user's email address. Note: During initial setup, Tenable configures approved domains for your Vulnerability Management instance. To add domains to your instance, contact Tenable Support.	Text	FALSE
Is Enabled	Specifies whether the user account is enabled (`true`) or disabled (`false`).	True/False	FALSE
Predefined Role	The user role represented as an integer value, as described in User Roles. Values: `Basic` `Scan Operator` `Standard` `Scan Manager` `Administrator` Note: You can only assign predefined User Roles. You can use Update User Role card to assign Custom Roles.	Dropdown	FALSE

Output

Field	Definition	Type
User
ID	The unique identifier of the user.	Text
UUID	The UUID of the user.	Text
Username	The username for the user.	Text
Email	The email address of the user. If this attribute is empty, Tenable Vulnerability Management uses the username value as the email address of the user.	Text
Full Name	The full name of the user.	Text
Is Enabled	Specifies whether the user account is enabled (`true`) or disabled (`false`).	True/False
Container UUID	The UUID of the Tenable Vulnerability Management instance to which the user belongs.	Text
Is Lockedout	Specifies whether the user can sign in to the Tenable Vulnerability Management app (`false`) or is locked out (`true`). Tenable Vulnerability Management automatically updates this attribute to true if the `login_fail_count` attribute for the user is greater than 5. To unlock a user account, reset the password of the user using the Change User Password card (chaange password endpoint). Note: A user can be locked out of the user interface but still submit API requests if they are assigned the appropriate authorizations (`api_permitted`). To prevent a user from submitting API requests, limit authorizations using the update user authorizations endpoint, or disable the user entirely using the Update User card (update user endpoint) or enable user account endpoint.	True/False
Type	The type of user. Note: The only supported type is `local`.	Text
Predefined Role	The user role represented as an integer value, as described in User Roles. Note: The value of this field is `0` if the user is assigned a Custom Role.	Number
Groups	A list of UUIDs for the groups to which the user belongs.	List of Text
Two Factor	Two-factor authentication details. Note: This field is omitted unless the user has set up two-factor authentication.	Object
Activated At	Activation time for two-factor authentication, represented in Unix milliseconds.	Number
Is TOTP Enabled	Specifies whether the TOTP two-factor authentication is enabled (`true`) or disabled (`false`).	True/False
Is Email Enabled	Indicates whether backup notification for two-factor authentication is enabled (`true`) or disabled (`false`). If enabled, Tenable Vulnerability Management sends the two-factor verification code in an email.	True/False
Last Successful Login	The last time (in Unix milliseconds) that the user successfully signed in to the Tenable Vulnerability Management app. Note: This attribute is only present if the user has logged in at least once successfully to the Tenable Vulnerability Management user interface.	Number
Last Failed Login	The time (in Unix milliseconds) of the last time the user failed to sign in to Tenable Vulnerability Management. Note: This attribute is only present if the user has attempted unsuccessfully to sign in to the Tenable Vulnerability Management app.	Number
Login Fail Count	The number of failed sign-in attempts since the user last successfully signed in to the Tenable Vulnerability Management app. Note: If this attribute is greater than `5`, Tenable Vulnerability Management locks the user account (updates the `Is Lockedout (lockout)` attribute for the user to `true` (`1`)). You can reset this count to `0` by using Change User Password card (changing the password of the user) or generating the API key of the user.	Number
Login Fail Total	The total number of failed sign-in attempts for the user.	Number
Raw Output	The raw response body that's returned by the API.	Object