All Products
Search

This Product

    CloudSSO:GetUserProvisioningEvent

    Document Center

    CloudSSO:GetUserProvisioningEvent

    Last Updated:Jul 11, 2024

    Queries the information about a Resource Access Management (RAM) user provisioning.

    Debugging

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

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    EventIdstringYes

    The ID of the RAM user provisioning event.

    You can call the ListUserProvisioningEvents operation to query the value of EventId.

    		upe-wjKyNDmZvyZOiRcJ****
    DirectoryIdstringYes

    The ID of the resource directory.

    		d-003qew84****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		B801715C-97EA-3067-AC97-EF1EBECBB39C
    UserProvisioningEventobject

    The RAM user provisioning event.

    UserProvisioningIdstring

    The ID of the RAM user provisioning event.

    		up-002axzhapcbz6e63****
    PrincipalIdstring

    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*****
    TargetPathstring

    The path of the resource directory in which you create the RAM user provisioning for the object.

    		rd-******/root/test**
    ErrorInfostring

    The error message that is displayed when the last execution of the RAM user provisioning event failed.

    		OperationConflict.UserProvisioning.Process.fail.ImsUserExists
    SourceTypestring

    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
    UpdateTimestring

    The modification time. The time is displayed in UTC.

    		2022-11-28T03:55:42Z
    DuplicationStrategystring

    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
    DeletionStrategystring

    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.
    		Delete
    PrincipalNamestring

    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
    TargetNamestring

    The name of the object for which you create the RAM user provisioning.

    The value is fixed as the name of the member in the resource directory.````

    		exampleRdMember
    ErrorCountlong

    The number of execution failures.

    		3
    TargetIdstring

    The ID of the object for which you create the RAM user provisioning.

    The value is fixed as the ID of the member in the resource directory.````

    		1743382******
    CreateTimestring

    The creation time. The time is displayed in UTC.

    		2022-11-28T03:55:42Z
    DirectoryIdstring

    The ID of the resource directory.

    		d-003qew84****
    TargetTypestring

    The object for which you create the RAM user provisioning. The value is fixed as RD-Account.

    		RD-Account
    EventIdstring

    The ID of the RAM user provisioning event.

    		upe-wjKyNDmZvyZOiRcJ****
    PrincipalTypestring

    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
    LatestAsyncTimestring

    The time at which the RAM user provisioning event was last executed. The time is displayed in UTC.

    		2022-11-28T03:55:42Z

    Examples

    Sample success responses

    JSONformat

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

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