火山引擎 icon

火山引擎

火山引擎 API 集成,支持 IAM 和自定义请求功能

IAM 用户 → 更新用户登录配置

AI-generated

Summary

Update the login profile of an IAM user by specifying their username, new password, and login-related configuration settings including login permission, password reset requirement, login protection enablement, protection types, and exemption settings.

Inputs

  • UserName (required) — The username of the IAM user whose login profile will be updated.
  • Password — The new login password for the user.
  • LoginAllowed — Whether the user is allowed to login (true to allow, false to disallow). Defaults to false.
  • PasswordResetRequired — Whether the user is required to reset their password upon next login (true to require, false otherwise). Defaults to false.
  • SafeAuthFlag — Whether login protection is enabled (true to enable, false to disable). Defaults to false.
  • SafeAuthType — The type(s) of login protection to enable, such as phone verification, email verification, MFA device verification, or combination thereof. Defaults to phone.
  • SafeAuthExemptRequired — Whether login protection exemption is enabled (1 to enable, 0 to disable). When enabled, successful verification exempts login protection for a set time period. Defaults to 0.
  • SafeAuthExemptUnit — The time unit for which the login protection exemption applies: minutes (0), hours (1), or days (2). Defaults to minutes.
  • SafeAuthExemptDurationMinutes — Duration in minutes for login protection exemption (valid when unit is minutes). Range: 5-1440. Defaults to 5.
  • SafeAuthExemptDurationHours — Duration in hours for login protection exemption (valid when unit is hours). Range: 1-168. Defaults to 1.
  • SafeAuthExemptDurationDays — Duration in days for login protection exemption (valid when unit is days). Range: 1-7. Defaults to 1.

Output shape

a single JSON object per input item representing the updated IAM user's login profile status or error information

Outputs one item per input. On success, each item contains updated login profile details. On failure, the item includes an error description. No pagination is involved.

Examples

Example 1: Update the login profile for user "alice" to set a new password, allow login, require password reset on next login, enable login protection with phone and email verification, and enable exemption for 1 hour.

UserName=alice, Password=securePass123, LoginAllowed=true, PasswordResetRequired=true, SafeAuthFlag=true, SafeAuthType=phone,email, SafeAuthExemptRequired=1, SafeAuthExemptUnit=1 (hours), SafeAuthExemptDurationHours=1

Links

Discussion