CreateLoginProfile - 新建IAM用户登录配置--访问控制-火山引擎

文档中心

立即注册

导航

CreateLoginProfile - 新建IAM用户登录配置

最近更新时间：2024.11.04 20:45:30首次发布时间：2021.02.23 10:42:32

为指定IAM用户新建登录配置。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateLoginProfile	要执行的操作，取值：CreateLoginProfile。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	是	Bob	用户名
Password	String	是	1&Eo34qe5**@	登录密码。
LoginAllowed	Boolean	否	true	是否允许登录。true代表允许，flase代表不允许，默认为flase。
PasswordResetRequired	Boolean	否	true	下次登录是否需要重设密码。true代表允许，flase代表不允许，默认为flase。
SafeAuthFlag	Boolean	否	false	是否开启登录保护。true代表开启，flase代表不开启，默认为flase。
SafeAuthType	String	否	phone,email	登录保护类型。phone代表手机验证，email代表邮箱验证，vmfa代表验证MFA设备验证。支持设置多种操作保护类型，以英文逗号分隔。，可选vmfa, phone, email, 多个选项逗号隔开。
SafeAuthExemptRequired	Integer	否	0	是否开启登录保护豁免。0代表不开启，1代表开启。开启登录保护豁免后，验证完成后一定时间内登录将不再进行验证。
SafeAuthExemptUnit	Integer	否	0	登录保护豁免的时间单位。0代表分钟，1代表小时，2代表天。
SafeAuthExemptDuration	Integer	否	15	登录保护豁免时长。支持设置1至7（天），或1至168（小时），或5至1440（分钟）。单位设置请参考SafeAuthExemptUnit参数。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
LoginProfile	Object	请参考数据结构内具体参数示例值。	登录配置的数据结构。

请求示例

GET /?Action=CreateLoginProfile&Version=2018-01-01&UserName=Bob&Password=1234qwerASDF&LoginAllowed=true&PasswordResetRequired=true&SafeAuthFlag=true&SafeAuthType=phone&SafeAuthExemptDuration=10&SafeAuthExemptRequired=0&SafeAuthExemptUnit=0 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240913T101742Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240913/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202409141125052391321680614682F7",
    "Action": "CreateLoginProfile",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "LoginProfile": {
      "UserId": 10000,
      "UserName": "Bob",
      "LoginAllowed": true,
      "PasswordResetRequired": true,
      "PasswordExpireAt": 0,
      "LastResetPasswordTime": 1701763622,
      "LastLoginDate": "20240913T053436Z",
      "LastLoginIp": "211.**.**.155",
      "LoginLocked": true,
      "SafeAuthFlag": true,
      "SafeAuthType": "phone",
      "SafeAuthExemptRequired": 0,
      "SafeAuthExemptUnit": 0,
      "SafeAuthExemptDuration": 15,
      "CreateDate": "20230614T095016Z",
      "UpdateDate": "20230614T095016Z"
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidPassword	Given password does not satisfy required password policy	密码不符合规则。
404	UserNotExist	User does not exist	用户不存在。
500	ServiceFailure	The requested service failed due to an unknown error	内部服务错误。