ImportUsersFromIam--云堡垒机-火山引擎

文档中心

立即注册

导航

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ImportUsersFromIam	接口名称。当前 API 的名称为 `ImportUsersFromIam`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
IamIds	Array of Long	是	[8*4, 2*82]	IAM 用户 ID 列表。
StartTime	String	是	2023-09-12 10:34:30	有效登录起始时间。
EndTime	String	是	2023-09-12 10:34:30	有效登录结束时间。
InstanceId	String	是	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
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	20	满足筛选条件的用户总数。
Success	Array of IamUser		导入成功的用户列表。
Failure	Array of IamUser		导入失败的用户列表。

IamUser

参数	类型	示例值	描述
Email	String	john@example.com	用户邮箱。
IamId	Long	31**82	IAM ID。
Phone	String	137****889	用户电话。
AuthPath	String	Platform	用户来源，取值： Platform：从 IAM 中导入的用户。 AD：从 AD 服务器中导入的用户。
Imported	Boolean	true	该用户是否已经导入过当前堡垒机，取值： true：已经导入过。 false：未导入过。
UserName	String	John	用户名称。
CreatedBy	String	John	创建者。
DisplayName	String	John	显示名称。
IamAccountId	Long	14*****042	IAM 账户 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
            }
        ]
    }
}

错误码

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