CreateUserProvisioning-创建 IAM 用户同步任务--云身份中心-火山引擎

文档中心

导航

CreateUserProvisioning-创建 IAM 用户同步任务

最近更新时间：2023.05.16 14:31:52首次发布时间：2023.05.16 14:31:52

创建 IAM 用户同步任务

请求参数

名称	类型	是否必填	描述
TargetId	String	是	目标id
PrincipalId	String	是	身份id
Description	String	否	任务描述
DuplicationSuffix	String	否	本次同步IAM用户名称后缀（冲突策略若选择 KeepBoth 则必填）
PrincipalType	String	是	身份类型： User: 用户
IdentitySourceStrategy	String	是	身份源冲突策略 Create: 新建 Ignore: 忽略
DeletionStrategy	String	是	删除策略 Keep: 保留 Delete: 删除
DuplicationStrategy	String	是	用户名冲突策略 KeepBoth: 两者都保留 Takeover: 替换

请求示例

{
  "DuplicationStrategy": "KeepBoth",
  "DuplicationSuffix": "-sso",
  "DeletionStrategy": "Keep",
  "IdentitySourceStrategy": "Ignore",
  "PrincipalId": "13947392",
  "PrincipalType": "User",
  "TargetId": "2100247160"
}

响应参数

名称	类型	示例值	描述
Remark	String	ExistDuplicatedIamUser：重名用户、ExistHomologousIamUser：同源用户	任务结果说明
Description	String		任务描述
TargetId	String		目标id
IdentitySourceStrategy	String		身份源冲突策略
DuplicationSuffix	String		本次同步IAM用户名称后缀
DuplicationStrategy	String		用户名冲突策略
DeletionStrategy	String		删除策略
PrincipalType	String		身份类型
PrincipalId	String		身份id
UserProvisioningId	String		IAM 用户同步任务ID

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202304261745188F5CDD3D3088649AB561",
    "Action": "CreateUserProvisioning",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "UserProvisioningId": "14017536",
    "DuplicationStrategy": "KeepBoth",
    "DuplicationSuffix": "-sso",
    "DeletionStrategy": "Keep",
    "IdentitySourceStrategy": "Ignore",
    "Description": "",
    "PrincipalId": "13947648",
    "PrincipalType": "User",
    "TargetId": "2100246810",
    "Remark": ""
  }
}

错误码

HttpCode	错误码	错误信息	描述
400	PermissionError	No permission to perform action[%s] on resource %s	没有接口权限
400	ServiceStatusException	Can not perform action[%s] when service is %s	企业身份中心实例不可用
500	InternalError	Unknown internal error: %v	服务内部错误
400	SensitiveWord	Include sensitive Word	参数存在敏感词
403	PermissionDenied	No permission to perform action[%s]	无权限访问
400	ConcurrentException	Concurrent request exception	存在请求并发冲突
400	ParamMissing	Missing parameter %v	参数缺省
400	InvalidParam	The parameter %v[%v] is invalid	无效参数
409	UserProvisioningAlreadyExists	UserProvisioning already exists	用户同步任务已存在
400	AccountNotInOrg	Account[%v] is not in your organization	目标账号不是组织成员
400	UserNameLengthExceedLimit	UserName length is out of limit	用户名长度过长
400	ExceedBindPersonalIdpLimit	Exceeded maximum account quota allowed bind to this third party account	已达到最大绑定限制数量
409	UserNameDuplicatedException	There is same name IAM user in Target account and can not solve the conflict by duplication strategy	创建 iam 用户，用户名冲突，且冲突策略无法解决冲突