All Products
Search
Document Center

CloudSSO:UpdateUserProvisioning

Last Updated:Jun 14, 2024

Modifies 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
DirectoryIdstringYes

The ID of the resource directory.

d-003qew84****
UserProvisioningIdstringYes

The ID of the RAM user provisioning.

up-002axzhapcbz6e63****
NewDuplicationStrategystringNo

The new 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
NewDeletionStrategystringNo

The new 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
NewDescriptionstringNo

The new description of the RAM user provisioning.

description*****

Response parameters

ParameterTypeDescriptionExample
object

The returned results.

UserProvisioningobject

The information about the RAM user provisioning.

Statusstring

The status of the RAM user provisioning. Valid values:

  • Enabled
  • Disabled
Enabled
Descriptionstring

The description for the RAM user provisioning.

This is a user provisioning.
UserProvisioningIdstring

The ID of the RAM user provisioning.

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

The modification time.

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.
testUserName
TargetNamestring

The name of the object for which you create the RAM user provisioning. The value is fixed as the name of the resource directory.

testMemberName
TargetIdstring

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.

u-02ha881d*****
CreateTimestring

The creation time.

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

The ID of the resource directory.

d-003qew84****
OwnerPkstring

The ID of the Alibaba Cloud account to which the resource directory belongs.

164987310*****
TargetTypestring

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

RD-Account
PrincipalTypestring

The identity type of the RAM user provisioning. Valid values:

  • User: indicates that the identity of the RAM user provisioning is a CloudSSO user.
  • Group: indicates that the identity of the RAM user provisioning is a CloudSSO user group.
User
RequestIdstring

The request ID.

F6F90F3D-4502-5877-B80B-97476F6AE2CC

Examples

Sample success responses

JSONformat

{
  "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": "testUserName",
    "TargetName": "testMemberName",
    "TargetId": "u-02ha881d*****",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "OwnerPk": "164987310*****",
    "TargetType": "RD-Account",
    "PrincipalType": "User"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

Error codes

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