Use GetUserProvisioningEvent to query RAM user provisioning event information - CloudSSO - Alibaba Cloud - CloudSSO

Queries the details of a failed RAM user provisioning event.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:GetUserProvisioningEvent

get

UserProvisioning

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/{#UserProvisioningId}

UserProvisioning

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user-provisioning/*

None

Request parameters

Parameter	Type	Required	Description	Example
EventId	string	Yes	The ID of the RAM user provisioning event. You can call the ListUserProvisioningEvents operation to query the value of `EventId`.	upe-wjKyNDmZvyZOiRcJ****
DirectoryId	string	Yes	The ID of the directory.	d-003qew84****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B801715C-97EA-3067-AC97-EF1EBECBB39C
UserProvisioningEvent	object	The RAM user provisioning event.
UserProvisioningId	string	The ID of the RAM user provisioning.	up-002axzhapcbz6e63****
PrincipalId	string	The identity ID of the RAM user provisioning. Valid values: If `Group` is returned for the `PrincipalType` parameter, the value of this parameter is the ID of a CloudSSO user group (g-******). If `User` is returned for the `PrincipalType` parameter, the value of this parameter is the ID of a CloudSSO user (u-******).	g-02ha881d*****
TargetPath	string	The path of the RAM user provisioning target in the resource directory.	rd-****/root/test
ErrorInfo	string	The error message returned when the RAM user provisioning event last 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.	AddUserToGroup
UpdateTime	string	The time when the RAM user provisioning event was last modified, in UTC and ISO 8601 format.	2022-11-28T03:55:42Z
DuplicationStrategy	string	The conflict handling policy used when a RAM user has the same username as the CloudSSO user being 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 for managing 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.	Delete
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 target of the RAM user provisioning. If `RD-Account` is returned for the `TargetType` parameter, the value of this parameter is the name of the account in the resource directory.	exampleRdMember
ErrorCount	integer	The number of execution failures.	3
TargetId	string	The ID of the target of the RAM user provisioning. If `RD-Account` is returned for the `TargetType` parameter, the value of this parameter is the ID of the account in the resource directory.	1743382******
CreateTime	string	The time when the RAM user provisioning event was created, in UTC and ISO 8601 format.	2022-11-28T03:55:42Z
DirectoryId	string	The ID of the directory.	d-003qew84****
TargetType	string	The type of the target of 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 when the RAM user provisioning event was last executed, in UTC and ISO 8601 format.	2022-11-28T03:55:42Z

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.