文档

SetSecurityPreference - 设置RAM用户的全局安全首选项

更新时间:

设置RAM用户的全局安全首选项信息。

接口说明

使用说明

本文将提供一个示例,引导用户进行安全设置,实现在仅在 RAM 用户异常登录时要求进行多因素认证。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ram:SetSecurityPreferenceWrite
  • 全部资源
    *
  • ram:MFAOperationForLogin

请求参数

名称类型必填描述示例值
EnableSaveMFATicketboolean

RAM 用户使用多因素认证登录后,是否允许保存多因素认证的验证状态,其有效期为 7 天。取值:

  • true:允许。
  • false(默认值):不允许。
false
AllowUserToChangePasswordboolean

是否允许 RAM 用户自主管理密码。取值:

  • true(默认值):允许。
  • false:不允许。
true
AllowUserToManageAccessKeysboolean

是否允许 RAM 用户自主管理访问密钥。取值:

  • true:允许。
  • false(默认值):不允许。
false
AllowUserToManageMFADevicesboolean

是否允许 RAM 用户自主管理多因素认证设备。取值:

  • true(默认值):允许。
  • false:不允许。
true
LoginSessionDurationinteger

RAM 用户登录有效期。

取值范围:1~24。单位:小时。

默认值:6。

6
LoginNetworkMasksstring

登录掩码。登录掩码决定哪些 IP 地址会受到登录控制台的影响,包括密码登录和单点登录(SSO),但使用访问密钥发起的 API 调用并不受影响。

  • 如果指定掩码,RAM 用户只能从指定的 IP 地址进行登录。
  • 如果不指定任何掩码,登录控制台功能将适用于整个网络。

当需要配置多个登录掩码时,请使用分号(;)来分隔,例如:192.168.0.0/16;10.0.0.0/8。

最多配置 40 个登录掩码,总长度最大 512 个字符。

10.0.0.0/8
VerificationTypesarray

多因素认证的手段。

string

多因素认证的手段。取值:

  • sms:安全手机。
  • email:安全邮箱。
["sms", "email"]
AllowUserToManagePersonalDingTalkboolean

是否允许 RAM 用户自主管理个人钉钉的绑定与解绑。取值:

  • true(默认值):允许。
  • false:不允许。
true
OperationForRiskLoginstring

异常登录时是否二次验证 MFA。取值:

  • autonomous(默认值):可跳过,不强制绑定。
  • enforceVerify:强制绑定验证。
autonomous
MFAOperationForLoginstring

登录时必须使用 MFA(取代原 EnforceMFAForLogin 参数,原参数仍然有效,建议更新为新参数)。取值:

  • mandatory:强制所有 RAM 用户。原 EnforceMFAForLogin 对应取值为 true。
  • independent(默认值):依赖每个 RAM 用户的独立配置。原 EnforceMFAForLogin 对应取值为 false。
  • adaptive:仅异常登录时使用。
adaptive

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

返回结果。

SecurityPreferenceobject

安全首选项信息。

AccessKeyPreferenceobject

访问密钥首选项。

AllowUserToManageAccessKeysboolean

是否允许 RAM 用户自主管理访问密钥。

false
LoginProfilePreferenceobject

登录首选项。

EnableSaveMFATicketboolean

RAM 用户使用多因素认证登录后,是否允许保存多因素认证的验证状态,其有效期为 7 天。

false
LoginSessionDurationinteger

RAM 用户登录有效期。

6
LoginNetworkMasksstring

登录掩码。

10.0.0.0/8
AllowUserToChangePasswordboolean

是否允许 RAM 用户自主管理密码。

true
OperationForRiskLoginstring

异常登录时是否二次验证 MFA。

autonomous
MFAOperationForLoginstring

登录时必须使用 MFA(取代原 EnforceMFAForLogin 参数,原参数仍然有效,建议更新为新参数)。

adaptive
MFAPreferenceobject

多因素认证首选项。

AllowUserToManageMFADevicesboolean

是否允许 RAM 用户自主管理多因素认证设备。

false
VerificationPreferenceobject

多因素认证手段的首选项。

VerificationTypesarray

多因素认证的手段。

string

多因素认证的手段。

["sms", "email"]
PersonalInfoPreferenceobject

个人信息首选项。

AllowUserToManagePersonalDingTalkboolean

是否允许 RAM 用户自主管理个人钉钉的绑定与解绑。

true
RequestIdstring

请求 ID。

17494710-B4BA-4185-BBBB-C1A6ABDE1639

示例

正常返回示例

JSON格式

{
  "SecurityPreference": {
    "AccessKeyPreference": {
      "AllowUserToManageAccessKeys": false
    },
    "LoginProfilePreference": {
      "EnableSaveMFATicket": false,
      "LoginSessionDuration": 6,
      "LoginNetworkMasks": "10.0.0.0/8",
      "AllowUserToChangePassword": true,
      "OperationForRiskLogin": "autonomous",
      "MFAOperationForLogin": "adaptive"
    },
    "MFAPreference": {
      "AllowUserToManageMFADevices": false
    },
    "VerificationPreference": {
      "VerificationTypes": [
        "[\"sms\", \"email\"]"
      ]
    },
    "PersonalInfoPreference": {
      "AllowUserToManagePersonalDingTalk": true
    }
  },
  "RequestId": "17494710-B4BA-4185-BBBB-C1A6ABDE1639"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:VerificationTypes
出参OpenAPI 返回结构发生变更
2023-01-06OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OperationForRiskLogin
    新增入参:MFAOperationForLogin
    删除入参:EnforceMFAForLogin
出参OpenAPI 返回结构发生变更
2021-08-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:VerificationTypes
出参OpenAPI 返回结构发生变更
2021-08-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:EnforceMFAForLogin
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈