全部产品
Search

搜索本产品

    运维安全中心（堡垒机）：CreateUser - 创建用户

    文档中心

    运维安全中心（堡垒机）：CreateUser - 创建用户

    更新时间：Nov 27, 2024

    创建用户。

    接口说明

    本接口用于创建堡垒机的用户，支持添加本地用户、RAM 用户、AD 用户和 LDAP 用户。堡垒机管理员为运维员创建登录堡垒机的账户（即新建用户）后，运维员才能使用该账户登录堡垒机运维已授权的主机。

    本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    要新建用户的堡垒机实例的 ID。

    说明 您可以调用 DescribeInstances 接口获取该参数。
    		bastionhost-cn-st220aw****
    RegionIdstring否

    要新建的用户的堡垒机的地域 ID。

    说明 地域 ID 和地域名称的对应关系，请参见地域和可用区。
    		cn-hangzhou
    Sourcestring是

    要新建的用户的来源。取值：

    • Local：本地用户
    • Ram：RAM 用户
    • AD：AD 用户
    • LDAP：LDAP 用户
    		Local
    UserNamestring是

    要新建的用户的登录名称。该参数只能由字母、数字、下划线（_）组成，最多支持 128 字符。

    		abc_def
    Passwordstring否

    要新建的用户的登录密码。 至少 8 位，至少包含大小写字母、数字、特殊符号，最多支持 128 字符。

    说明 新创建用户来源为本地用户（即 Source 取值为 Local）时，该参数为必填项。
    		213****
    DisplayNamestring否

    要新建的用户的显示姓名。最多支持 128 字符。

    说明 未填写则默认采用登录名作为显示姓名。
    		Bob
    Commentstring否

    要新建的用户的备注信息。最多支持 500 字符。

    		comment
    Emailstring否

    要新建的用户的邮箱。

    说明
  • 当 TwoFactorStatus 为“Enable”，且 TwoFactorMethods 为“email”时，或当 TwoFactorStatus 为“Global”，且全局双因子配置中 TwoFactorMethods 为“email”时，该参数为必填。
  • 您可以调用 GetInstanceTwoFactor 接口获取全局双因子配置
    •
    		username@example.com
    Mobilestring否

    要新建的用户的手机号码。

    说明
  • 当 TwoFactorStatus 为“Enable”，且 TwoFactorMethods 为“sms”或“dingtalk”时，或当 TwoFactorStatus 为“Global”，且全局双因子配置中 TwoFactorMethods 为“sms”或“dingtalk”时，该参数为必填。
  • 您可以调用 GetInstanceTwoFactor 接口获取全局双因子配置
    •
    		1359999****
    SourceUserIdstring否

    要新建的用户的唯一标识。

    说明
  • 该参数是堡垒机用户对应的 RAM 用户的唯一标识。新创建用户来源为 RAM 用户（即 Source 取值为 Ram）时，该参数为必填项。您可以调用访问控制的 ListUsers 接口从返回数据 UserId 获取该参数。
  • 新创建用户来源为 AD 或 LDAP 时，该参数为必填项，取值为用户的 DN。
    •
    		122748924538****
    MobileCountryCodestring否

    要新建的用户手机号的国际域名。默认值为 CN，取值：

    • CN：中国内地（+86）
    • HK：中国香港（+852）
    • MO：中国澳门（+853）
    • TW：中国台湾（+886）
    • RU：俄罗斯（+7）
    • SG：新加坡（+65）
    • MY：马来西亚（+60）
    • ID：印度尼西亚（+62）
    • DE：德国（+49）
    • AU：澳大利亚（+61）
    • US：美国（+1）
    • AE：迪拜（+971）
    • JP：日本（+81）
    • GB：英国（+44）
    • IN：印度（+91）
    • KR：韩国（+82）
    • PH：菲律宾（+63）
    • CH：瑞士（+41）
    • SE：瑞典（+46）
    • SA：沙特（+966）
    		CN
    EffectiveStartTimelong否

    用户有效期开始时间（秒，时间戳格式）

    		1669630029
    EffectiveEndTimelong否

    用户有效期结束时间（秒，时间戳格式）

    		1672502400
    NeedResetPasswordboolean否

    下次登录是否需要重置密码。取值：

    • true：是
    • false：否
    说明 未填时默认为 false。
    		true
    TwoFactorStatusstring否

    用户双因子状态，取值：

    • Global：遵循全局设定
    • Disable：关闭双因子
    • Enable：开启双因子，遵循单个用户设定
    说明 未填时默认为 Global。
    		Enable
    TwoFactorMethodsstring否

    打开双因子认证方式的数组，目前最多支持一个，取值：

    • sms：短信
    • email：邮件
    • dingtalk：钉钉
    • totp：OTP 令牌
    • gmusbkey：国密 USBKEY
    说明 当 TwoFactorStatus 为“Enable”时，至少指定一种。
    		["sms"]
    LanguageStatusstring否

    消息通知语言设置。

    • Global：遵循全局
    • Custom：自定义
    说明 未填时默认为 Global。
    		Custom
    Languagestring否

    当 LanguageStatus 为 Custom 时，Language 为必填。 取值：

    • zh-cn：简体中文
    • en：英文
    		en

    调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

    调用 API 的请求格式，请参见本文示例中的请求示例。

    返回参数

    名称类型描述示例值
    object

    响应数据。

    UserIdstring

    新建的用户的 ID。

    		1
    RequestIdstring

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    示例

    正常返回示例

    JSON格式

    {
  "UserId": "1",
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameterThe argument is invalid.参数错误
    400UserAlreadyExistsThe user already exists.用户已存在
    500InternalErrorAn unknown error occurred.未知错误

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

    变更历史

    变更时间变更内容概要操作
    2024-02-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情