GetUserProvisioningEvent - 查询RAM用户同步事件_云SSO(CloudSSO)-阿里云帮助中心

调用GetUserProvisioningEvent查询执行失败的RAM用户同步事件。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cloudsso:GetUserProvisioningEvent	get	UserProvisioning acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/{#UserProvisioningId} UserProvisioning acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/*	无	无

请求参数

名称	类型	必填	描述	示例值
EventId	string	是	RAM 用户同步事件 ID。您可以调用 ListUserProvisioningEvents 获取`EventId`。	upe-wjKyNDmZvyZOiRcJ****
DirectoryId	string	是	目录 ID。	d-003qew84****

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	B801715C-97EA-3067-AC97-EF1EBECBB39C
UserProvisioningEvent	object	RAM 用户同步事件。
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
ErrorInfo	string	RAM 用户同步事件上次执行失败的错误信息。	OperationConflict.UserProvisioning.Process.fail.ImsUserExists
SourceType	string	源操作类型。取值： StartProvisioning：启用 RAM 用户同步。 DeleteProvisioning：删除 RAM 用户同步。 AddUserToGroup：用户加入用户组。 RemoveUserFromGroup：用户从用户组移出。 UserProvisioningDeletionClearing：删除 RAM 用户同步之后，后台进行资源清理。	AddUserToGroup
UpdateTime	string	修改时间（UTC 时间）。	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 用户名称。	exampleGroupName
TargetName	string	RAM 用户同步的目标名称。当`TargetType`为`RD-Account`时，取值为 RD 账号名称。	exampleRdMember
ErrorCount	long	执行失败次数。	3
TargetId	string	RAM 用户同步的目标 ID。当`TargetType`为`RD-Account`时，取值为 RD 账号 ID。	1743382******
CreateTime	string	创建时间（UTC 时间）。	2022-11-28T03:55:42Z
DirectoryId	string	目录 ID。	d-003qew84****
TargetType	string	RAM 用户同步的目标类型。目前取值为`RD-Account`。	RD-Account
EventId	string	RAM 用户同步事件 ID。	upe-wjKyNDmZvyZOiRcJ****
PrincipalType	string	RAM 用户同步的身份类型。取值： User：表示该 RAM 用户同步的身份是云 SSO 用户。 Group：表示该 RAM 用户同步的身份是云 SSO 用户组。	Group
LatestAsyncTime	string	此事件上次执行的时间（UTC 时间）。	2022-11-28T03:55:42Z

示例

正常返回示例

JSON格式

{
  "RequestId": "B801715C-97EA-3067-AC97-EF1EBECBB39C",
  "UserProvisioningEvent": {
    "UserProvisioningId": "up-002axzhapcbz6e63****",
    "PrincipalId": "g-02ha881d*****",
    "TargetPath": "rd-******/root/test**",
    "ErrorInfo": "OperationConflict.UserProvisioning.Process.fail.ImsUserExists",
    "SourceType": "AddUserToGroup",
    "UpdateTime": "2022-11-28T03:55:42Z",
    "DuplicationStrategy": "KeepBoth",
    "DeletionStrategy": "Delete",
    "PrincipalName": "exampleGroupName",
    "TargetName": "exampleRdMember",
    "ErrorCount": 3,
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "TargetType": "RD-Account",
    "EventId": "upe-wjKyNDmZvyZOiRcJ****",
    "PrincipalType": "Group",
    "LatestAsyncTime": "2022-11-28T03:55:42Z"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史