文档首页/云客服/API参考/系统配置类接口参考（API Fabric）/联邦用户管理接口/创建管理联邦用户任务 (createTask)
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

创建管理联邦用户任务 (createTask)

场景描述

创建管理联邦用户任务。

接口方法

POST

接口URI

https://域名/apiaccess/rest/cc-management/v1/federationUserMgmt/createTask，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

True

appKey字段，用户标识

2

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

requestBody

object

True

联邦用户信息。

1.1

federationUserList

array[object]

True

联邦用户列表。

用户数量不超过100个。

1.1.1

action

string

True

操作类型：

  • CREATE
  • MODIFY
  • DISABLE

1.1.2

userName

string

False

联邦用户名，当action的操作类型为CREATE时，参数必填。action的操作类型为DISABLE时不使用。

1.1.3

userAccount

string

True

联邦用户账号。

1.1.4

email

string

False

联邦用户邮箱，当action的操作类型为CREATE时，参数必填。action的操作类型为DISABLE时不使用。

1.1.5

roleIds

array[string]

False

分配给此联邦用户的角色ID列表，支持配置多个角色ID。

当action的操作类型为CREATE或MODIFY时可选。

action的操作类型为DISABLE时不使用。

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    是否必选

    说明

    1

    schema

    object

    True

    操作结果信息。

    1.1

    resultCode

    string

    False

    返回码。

    • 0：成功
    • 其他的表示失败，详情请参见表4。

    1.2

    resultMessage

    string

    False

    返回结果描述信息。

    1.3

    taskId

    string

    False

    成功时返回的任务ID。

  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

表4 错误码

错误码

描述

100-102

用户管理列表为空

100-103

用户管理列表超过100大小限制

100-104

用户管理Action字段值必填且只能是CREATE或者MODIFY或者DISABLE

100-113

租间待执行与执行中的联邦用户任务已达到限制

100-202

roleIds长度超过限制

100-204

userAccount为空或者为空字符串

100-205

userAccount长度超过限制

100-207

userAccount含有特殊字符

100-208

roleId不为数字

100-209

当action为CREATE时，userName为空或者为空字符串

100-210

userName含有特殊字符

100-211

email为空或者为空字符串

100-212

email字符或者格式不合法

100-213

userName长度超过限制

100-214

email长度超过限制

100-215

roleIds数组大小超过限制

100-216

获取角色列表信息失败

100-217

租间不存在该角色，角色Id: {roleId}

报文样例

请求头:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json
请求参数: 
{
    "federationUserList": [
        {
	    "action": "CREATE",
	    "userAccount": "test0616",
	    "userName": "test0616name",
	    "email": "test0616@huawei.com",
	    "roleIds": ["1672380646005741634"]
	},
	{
	    "action": "MODIFY",
	    "userAccount": "test0616",
	    "userName": "test0616new",
	    "email": "test0616new@huawei.com"
	},
	{
	    "action": "DISABLE",
	    "userAccount": "test0616"
	}
    ]
}

响应参数:

{
     "resultCode": "0",
     "resultMessage": "batch task created successfully.",
     "taskId": "1659444411225432066"
 }

相关文档