updateUserById()用于更新用户数据。

案例教程

案例1 (更新用户的电子邮件地址)

案例2 (更新用户的密码)

案例3 (更新用户的元数据)

案例4 (更新用户的应用程序元数据)

案例5 (确认用户的电子邮件地址)

案例6 (确认用户的电话号码)

参数说明

  • uid [必要参数] string类型

    用户的唯一标识符。

  • attributes [必要参数] AdminUserAttributes类型

      特性
    • app_metadata [可选参数] object类型

      用于存储用户特定应用程序元数据的自定义数据对象。这映射到 auth.users.app_metadata 列。只有服务角色可以修改。app_metadata 应该是一个 JSON 对象,其中包含应用程序特定的信息,例如身份提供者、角色和其他访问控制信息。

    • ban_duration [可选参数] string类型

      决定一个用户被禁止多长时间。

      确定用户被封禁的持续时间。封禁持续时间的格式遵循严格的十进制数字和单位后缀的顺序。有效的时间单位包括 “ns”、“us”(或 “µs”)、“ms”、“s”、“m”、“h”。例如,一些可能的持续时间包括:‘300ms’、‘2h45m’。将封禁持续时间设置为 ’none’ 将解除对用户的封禁。

    • email [可选参数] string类型

      该用户的电子邮件。

    • email_confirm [可选参数] boolean类型

      如果设置为 true,则确认用户的电子邮件地址。只有服务角色可以修改。

    • nonce [可选参数] string类型

      如果要更新用户的密码,则发送的重新认证的随机数。首先调用 reauthenticate() 来获取随机数。

    • password [可选参数] string类型

      用户的密码。

    • phone [可选参数] string类型

      用户的电话。

    • phone_confirm [可选参数] boolean类型

      如果设置为 true,则确认用户的电话号码。只有服务角色可以修改。

    • user_metadata [可选参数] object类型

      用于存储用户元数据的自定义数据对象。这映射到 auth.users.user_metadata 列。user_metadata 应该是一个 JSON 对象,其中包含用户特定的信息,例如他们的名字和姓氏。注意:在使用 GoTrueAdminApi 并想要修改用户的元数据时,将使用此属性代替 UserAttributes 数据。