You need to enable JavaScript to run this app.
导航
云堡垒机
  • 文档首页
    • /
  • 云堡垒机

ImportUsersFromIam

最近更新时间：2024.04.16 19:47:31

首次发布时间：2023.12.15 10:45:22

我的收藏

导入火山引擎 IAM 用户，将火山引擎中的 IAM 用户导入云堡垒机，并随机生成云堡垒机登录密码，可直接作为云堡垒机用户使用。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=ImportUsersFromIam&Version=2021-06-01

请求参数

参数类型是否必选示例值描述
ActionString是ImportUsersFromIam接口名称。当前 API 的名称为 ImportUsersFromIam。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
IamIdsArray of Long是[8***4, 2***82]IAM 用户 ID 列表。
StartTimeString是2023-09-12 10:34:30有效登录起始时间。
EndTimeString是2023-09-12 10:34:30有效登录结束时间。
InstanceIdString是vbh-14*****0042-wdk****z云堡垒机实例 ID。

FullTime

Boolean

是

true

是否全时段可登录，取值：

  • true： 全时段可登录。设置此值则不需要设置有效登录起始时间以及有效登录结束时间。
  • false： 有限时间段可登录。设置此值后必须设置有效登录起始时间以及有效登录结束时间。

请求示例

POST https://open.volcengineapi.com/?Action=ImportUsersFromIam&Version=2021-06-01
Content-Type: application/json
{
    "IamIds": [8***4, 2***82],
    "StartTime": "2023-09-12 10:34:30",
    "EndTime": "2023-09-12 10:34:30",
    "InstanceId": "vbh-14****0042-wdk2****",
    "FullTime": true
}

返回参数

参数类型示例值描述
TotalCountLong20满足筛选条件的用户总数。
SuccessArray of IamUser导入成功的用户列表。
FailureArray of IamUser导入失败的用户列表。

IamUser

参数类型示例值描述
EmailStringjohn@example.com用户邮箱。
IamIdLong31**82IAM ID。
PhoneString137****889用户电话。

AuthPath

String

Platform

用户来源，取值：

  • Platform：从 IAM 中导入的用户。
  • AD：从 AD 服务器中导入的用户。
ImportedBooleantrue该用户是否已经导入过当前堡垒机，取值： true：已经导入过。 false：未导入过。
UserNameStringJohn用户名称。
CreatedByStringJohn创建者。
DisplayNameStringJohn显示名称。
IamAccountIdLong14*****042IAM 账户 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ImportUsersFromIam",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 22,
        "Success": [
            {
                "UserName": "Jong",
                "DisplayName": "John",
                "Phone": "137****889",
                "Email": "john@example.com",
                "AuthPath": "Platform",
                "IamId": 31**82,
                "IamAccountId": 14*****042,
                "CreatedBy": "john",
                "Imported": true
            }
        ],
        "Failure": [
            {
                "UserName": "John",
                "DisplayName": "John",
                "Phone": "137****889",
                "Email": "john@example.com",
                "AuthPath": "Platform",
                "IamId": 31**82,
                "IamAccountId": 14*****042,
                "CreatedBy": "john",
                "Imported": true
            }
        ]
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考 公共错误码 进行故障排查。