Skip to main content

Alter User Field

Update the value of a single field in the definition of a user.

Syntax​

alter user <user reference> set <user field name> <value>

Parameters​

user reference​

Email — Username of the user to alter.

user field name​

String — A field from the user specification. Nested fields can be set using dot notation, and field names are matched case-insensitively.

value​

String, Number, Boolean, JSON, or List — The new value for the field. Strings must be quoted. Use none to clear a field that is optional in the specification.

The password field cannot be set this way. To change a user's password, use Set Password.