CreateUserProvisioning - 创建RAM用户同步_云SSO(CloudSSO)-阿里云帮助中心

调用CreateUserProvisioning创建RAM用户同步。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cloudsso:CreateUserProvisioning	Write	UserProvisioning acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/* Account acs:resourcemanager::{#accountId}:account/{#AccountId} Group acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId} User acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/{#UserId}	无	无

请求参数

名称	类型	必填	描述	示例值
DirectoryId	string	是	目录 ID。	d-003qew84****
DuplicationStrategy	string	是	冲突策略。当云 SSO 用户同步到 RAM 时，如果 RAM 中存在同名用户时的处理策略。取值： KeepBoth：两者都保留。当云 SSO 用户被同步到 RAM 时，如果 RAM 已经存在同名用户，则对云 SSO 用户的用户名添加后缀`_sso`后尝试创建该用户名的 RAM 用户。 TakeOver：替换。当云 SSO 用户被同步到 RAM 时，如果 RAM 已经存在同名用户，则直接将已经存在的 RAM 用户替换为云 SSO 同步用户。	KeepBoth
DeletionStrategy	string	是	删除策略。删除 RAM 用户同步时，对已同步的 RAM 用户的处理策略。取值： Delete：删除。删除 RAM 用户同步时，会删除从云 SSO 已经同步到 RAM 中的 RAM 用户。 Keep：保留。删除 RAM 用户同步时，会保留从云 SSO 已经同步到 RAM 中的 RAM 用户。	Delete
Description	string	否	描述。	This is a user provisioning.
PrincipalId	string	是	RAM 用户同步的身份 ID。取值：当`PrincipalType`取值为`Group`时，该值为云 SSO 用户组 ID（g-******）。当`PrincipalType`取值为`User`时，该值为云 SSO 用户 ID（u-******）。	g-02ha881d*****
PrincipalType	string	是	RAM 用户同步的身份类型。取值： User：表示该 RAM 用户同步的身份是云 SSO 用户。 Group：表示该 RAM 用户同步的身份是云 SSO 用户组。	Group
TargetId	string	是	RAM 用户同步的目标 ID。目前取值为 RD 账号 ID。	1743382******
TargetType	string	是	RAM 用户同步的目标类型。目前取值为`RD-Account`。	RD-Account

返回参数

名称	类型	描述	示例值
	object	返回参数。
UserProvisioning	object	RAM 用户同步信息。
Status	string	RAM 用户同步的状态。取值： Enabled：RAM 用户同步已启用。 Disabled：RAM 用户同步未启用。	Enabled
Description	string	描述。	this is a user provisioning.
UserProvisioningId	string	RAM 用户同步的 ID。	up-002axzhapcbz6e63****
PrincipalId	string	RAM 用户同步的身份 ID。取值：当`PrincipalType`取值为`Group`时，该值为云 SSO 用户组 ID（g-******）。当`PrincipalType`取值为`User`时，该值为云 SSO 用户 ID（u-******）。	g-02ha881d*****
TargetPath	string	RAM 用户同步的目标 RD 账号路径。	rd-****/root/test
UpdateTime	string	更新时间。	2022-11-28T03:55:42Z
DuplicationStrategy	string	冲突策略。当云 SSO 用户同步到 RAM 时，如果 RAM 中存在同名用户时的处理策略。取值： KeepBoth：两者都保留。当云 SSO 用户被同步到 RAM 时，如果 RAM 已经存在同名用户，则对云 SSO 用户的用户名添加后缀`_sso`后尝试创建该用户名的 RAM 用户。 TakeOver：替换。当云 SSO 用户被同步到 RAM 时，如果 RAM 已经存在同名用户，则直接将已经存在的 RAM 用户替换为云 SSO 同步用户。	KeepBoth
DeletionStrategy	string	删除策略。删除 RAM 用户同步时，对已同步的 RAM 用户的处理策略。取值： Delete：删除。删除 RAM 用户同步时，会删除从云 SSO 已经同步到 RAM 中的 RAM 用户。 Keep：保留。删除 RAM 用户同步时，会保留从云 SSO 已经同步到 RAM 中的 RAM 用户。	Delete
PrincipalName	string	RAM 用户同步的身份名称。取值：当`PrincipalType`取值为`Group`时，该值为云 SSO 用户组名称。当`PrincipalType`取值为`User`时，该值为云 SSO 用户名称。	testGroupName
TargetName	string	RAM 用户同步的目标名称。目前取值为 RD 账号名称。	testTargetName
TargetId	string	RAM 用户同步的目标 ID。目前取值为 RD 账号 ID。	1743382******
CreateTime	string	创建时间。	2022-11-28T03:55:42Z
DirectoryId	string	目录 ID。	d-003qew84****
OwnerPk	string	目录所属的主账号 ID。	1639738******
TargetType	string	RAM 用户同步的目标类型。目前取值为`RD-Account`。	RD-Account
PrincipalType	string	RAM 用户同步的身份类型。取值： User：表示该 RAM 用户同步的身份是云 SSO 用户。 Group：表示该 RAM 用户同步的身份是云 SSO 用户组。	Group
RequestId	string	请求 ID。	F6F90F3D-4502-5877-B80B-97476F6AE2CC

示例

正常返回示例

JSON格式

{
  "UserProvisioning": {
    "Status": "Enabled",
    "Description": "this is a user provisioning.",
    "UserProvisioningId": "up-002axzhapcbz6e63****",
    "PrincipalId": "g-02ha881d*****",
    "TargetPath": "rd-******/root/test**",
    "UpdateTime": "2022-11-28T03:55:42Z",
    "DuplicationStrategy": "KeepBoth",
    "DeletionStrategy": "Delete",
    "PrincipalName": "testGroupName",
    "TargetName": "testTargetName",
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "OwnerPk": "1639738******",
    "TargetType": "RD-Account",
    "PrincipalType": "Group"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

错误码

访问错误中心查看更多错误码。