ListUserProvisioningEvents - CloudSSO - Alibaba Cloud Documentation Center

Queries Resource Access Management (RAM) user provisioning events.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
UserProvisioningId	string	No	The ID of the RAM user provisioning.	up-002axzhapcbz6e63****
DirectoryId	string	Yes	The ID of the resource directory.	d-00xz91nf****
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The token that is used to initiate the next request. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter. When you call this operation for the first time, if the total number of entries to return is larger than the value of `MaxResults`, the entries are truncated. The system returns entries based on the value of `MaxResults`, and does not return the excess entries. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used to initiate the next request. Note This parameter is returned only when the `IsTruncated` parameter is set to `true`.	2eEMmhmLa1b7Bbj9UzCgZUGj8DpDeG5TbNknuNKNP2h84KjJRnAb7vzzSDkYNmsidnAybyJYBfnPPB6xfgw54B1Wub2KQmC8LofzqBW2Y****
RequestId	string	The request ID.	0D85B43D-EF98-396D-B426-837E428D2D39
TotalCounts	integer	The total number of entries returned.	110
MaxResults	integer	The maximum number of entries per page. Valid values: 1 to 100. Default value: 10.	10
IsTruncated	boolean	Indicates whether the queried entries are truncated. Valid values: true false	false
UserProvisioningEvents	array<object>	The RAM user provisioning events.
	object
UserProvisioningId	string	The ID of the RAM user provisioning.	up-002axzhapcbz6e63****
PrincipalId	string	The identity ID of the RAM user provisioning. Valid values: If you set the `PrincipalType` parameter to `Group`, the value of this parameter is the ID of a CloudSSO user group (g-******). If you set the `PrincipalType` parameter to `User`, the value of this parameter is the ID of a CloudSSO user (u-******).	g-02ha881d*****
TargetPath	string	The path of the resource directory in which you create the RAM user provisioning for the member.	rd-****/root/test
ErrorInfo	string	The error message that is displayed when the last execution of the RAM user provisioning event failed.	OperationConflict.UserProvisioning.Process.fail.ImsUserExists
SourceType	string	The type of the source operation. Valid values: StartProvisioning: enables the RAM user provisioning. DeleteProvisioning: deletes the RAM user provisioning. AddUserToGroup: adds a user to a user group. RemoveUserFromGroup: removes a user from a user group. UserProvisioningDeletionClearing: deletes the RAM user provisioning and clears resources in the background.	StartProvisioning
UpdateTime	string	The modification time. The time is displayed in UTC.	2022-11-28T03:55:55Z
DuplicationStrategy	string	The conflict handling policy. The policy is used when a RAM user has the same username as the CloudSSO user who is synchronized to RAM. Valid values: KeepBoth: When a CloudSSO user is synchronized to RAM, if a RAM user who has the same username as the CloudSSO user exists, the system creates a RAM user whose username is the username of the CloudSSO user plus the suffix `_sso`. TakeOver: When a CloudSSO user is synchronized to RAM, if a RAM user who has the same username as the CloudSSO user exists, the system replaces the RAM user with the CloudSSO user.	KeepBoth
DeletionStrategy	string	The deletion policy. The policy is used to manage synchronized users when you delete the RAM user provisioning. Valid values: Delete: When you delete the RAM user provisioning, the system deletes the synchronized users. Keep: When you delete the RAM user provisioning, the system retains the synchronized users.	Keep
PrincipalName	string	The identity name of the RAM user provisioning. Valid values: If `Group` is returned for the `PrincipalType` parameter, the value of this parameter is the name of a CloudSSO user group. If `User` is returned for the `PrincipalType` parameter, the value of this parameter is the name of a CloudSSO user.	exampleGroupName
TargetName	string	The name of the object for which you create the RAM user provisioning. If `RD-Account` is returned, the value of this parameter is the name of the account that is used to access the instance.``	exampleRdMember
ErrorCount	long	The number of execution failures.	1
TargetId	string	The ID of the object for which you create the RAM user provisioning. The value is fixed as the ID of the account in the resource directory.````	153218*******
CreateTime	string	The creation time. The time is displayed in UTC.	2022-11-28T03:55:55Z
DirectoryId	string	The ID of the resource directory.	d-003qew84****
TargetType	string	The object for which you create the RAM user provisioning. The value is fixed as `RD-Account`.	RD-Account
EventId	string	The ID of the RAM user provisioning event.	upe-wjKyNDmZvyZOiRcJ****
PrincipalType	string	The identity type of the RAM user provisioning. Valid values: User: The identity of the RAM user provisioning is a CloudSSO user. Group: The identity of the RAM user provisioning is a CloudSSO user group.	Group
LatestAsyncTime	string	The time at which the RAM user provisioning event was last executed. The time is displayed in UTC.	2022-11-28T03:55:55Z

Examples

Sample success responses

JSONformat

{
  "NextToken": "2eEMmhmLa1b7Bbj9UzCgZUGj8DpDeG5TbNknuNKNP2h84KjJRnAb7vzzSDkYNmsidnAybyJYBfnPPB6xfgw54B1Wub2KQmC8LofzqBW2Y****",
  "RequestId": "0D85B43D-EF98-396D-B426-837E428D2D39",
  "TotalCounts": 110,
  "MaxResults": 10,
  "IsTruncated": false,
  "UserProvisioningEvents": [
    {
      "UserProvisioningId": "up-002axzhapcbz6e63****",
      "PrincipalId": "g-02ha881d*****",
      "TargetPath": "rd-******/root/test**",
      "ErrorInfo": "OperationConflict.UserProvisioning.Process.fail.ImsUserExists",
      "SourceType": "StartProvisioning",
      "UpdateTime": "2022-11-28T03:55:55Z",
      "DuplicationStrategy": "KeepBoth",
      "DeletionStrategy": "Keep",
      "PrincipalName": "exampleGroupName",
      "TargetName": "exampleRdMember",
      "ErrorCount": 1,
      "TargetId": "153218*******",
      "CreateTime": "2022-11-28T03:55:55Z",
      "DirectoryId": "d-003qew84****",
      "TargetType": "RD-Account",
      "EventId": "upe-wjKyNDmZvyZOiRcJ****",
      "PrincipalType": "Group",
      "LatestAsyncTime": "2022-11-28T03:55:55Z"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.