Edit User

The Edit User task updates the properties of an existing user account. Provide at least one identifier (id, login, or email) to target the user. Only the fields you populate will be changed — fields left as null are not modified.

Configuration

Property	Type	Description
dry_run	boolean	Run without executing task effects
id	string	Internal user ID — provide one of id, login, or email to identify the target user
login	string	Username
email	string	Email address
name	string	Updated first name (null = no change)
surname	string	Updated last name (null = no change)
scopes	array	Replace the user's full scope set (null = no change)
add_groups	array	Group IDs to add the user to
remove_groups	array	Group IDs to remove the user from
unlock_user	boolean	Set to true to unlock a locked account
fail_if_not_found	boolean	Fail if no matching user is found
output_variable	string	Variable name to store the updated user object (e.g. "ucs.user")

---

See also: Tasks overview