You need to enable JavaScript to run this app.
导航
CreateUserProvisioning - 创建用户访问授权任务
最近更新时间:2025.03.21 11:07:41首次发布时间:2023.05.16 14:31:52
复制全文
我的收藏
有用
有用
无用
无用

创建用户访问授权任务

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateUserProvisioning

要执行的操作,取值:CreateUserProvisioning。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

TargetId
String

1

目标id

PrincipalType
String

User

身份类型

PrincipalId
String

1

身份id

Description
String

desc

任务描述

DuplicationStrategy
String

KeepBoth

用户名冲突策略

DuplicationSuffix
String

suffix

本次同步IAM用户名称后缀(冲突策略若选择 KeepBoth 则必填)

DeletionStrategy
String

Keep

删除策略

IdentitySourceStrategy
String

Ignore

身份源冲突策略

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
ProvisionStatus
String

Provisioned 授权成功,Provisioning 正在授权,DeleteProvisioning 授权解除中,DeleteProvisioned 授权解除成功

授权任务状态

Remark
String

ExistDuplicatedIamUser:重名用户、ExistHomologousIamUser:同源用户

任务结果说明

Description
String

desc

任务描述

TargetId
String

1

目标id

IdentitySourceStrategy
String

Ignore

身份源冲突策略

DuplicationSuffix
String

suffix

本次同步IAM用户名称后缀

DuplicationStrategy
String

KeepBoth

用户名冲突策略

DeletionStrategy
String

Keep

删除策略

PrincipalType
String

User

身份类型

PrincipalId
String

1

身份id

UserProvisioningId
String

1

IAM 用户同步任务ID

请求示例

POST /?Action=CreateUserProvisioning&Version=2023-01-01 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250310T064306Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250310/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "TargetId": "rr4t",
  "PrincipalType": "User",
  "PrincipalId": "JEiqlz2T0P",
  "Description": "KzRwcLnmQG",
  "DuplicationStrategy": "M",
  "DuplicationSuffix": "cYXqgs9u",
  "DeletionStrategy": "RQDuYkD",
  "IdentitySourceStrategy": "F7U3j3XQ"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202503101443102271550070981EA70F",
    "Action": "CreateUserProvisioning",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "ProvisionStatus": "Provisioned",
    "Remark": "ExistDuplicatedIamUser",
    "Description": "LNlej",
    "TargetId": "ilgp9YG5",
    "IdentitySourceStrategy": "Uf",
    "DuplicationSuffix": "Mn3L",
    "DuplicationStrategy": "eZ",
    "DeletionStrategy": "pcdwkcJEEcx",
    "PrincipalType": "gOz4i4RBC",
    "PrincipalId": "jWZTbck",
    "UserProvisioningId": "LfANIBJCe"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
PermissionError

No permission to perform action[%s] on resource %s

没有接口权限

400
ServiceStatusException

Can not perform action[%s] when service is %s

企业身份中心实例不可用

400
SensitiveWord

Include sensitive Word

参数重存在敏感词

400
ConcurrentException

Concurrent request exception

存在请求并发冲突

400
ParamMissing

Missing parameter %v

参数缺省

400
InvalidParam

The parameter %v[%v] is invalid

无效参数

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

已达到最大绑定限制数量

400
InvalidIdentitySourceStatus

identity source status is invalid

实例状态不符合预期

400
DisplayNameLengthExceedLimit

DisplayName length is out of limit

显示名过长

403
PermissionDenied

No permission to perform action[%s]

无权限访问

404
UserGroupNotFound

User group is not found

用户组不存在

409
UserProvisioningAlreadyExists

UserProvisioning already exists

用户同步任务已存在

409
UserNameDuplicatedException

There is same name IAM user in Target account and can not solve the conflict by duplication strategy

创建 iam 用户,用户名冲突,且冲突策略无法解决冲突

500
InternalError

Unknown internal error: %v

服务内部错误