Modify a RAM user provisioning by calling the UpdateUserProvisioning API - CloudSSO

Modifies a Resource Access Management (RAM) user provisioning.

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:UpdateUserProvisioning

update

*UserProvisioning

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

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the resource directory.	d-003qew84****
UserProvisioningId	string	Yes	The ID of the RAM user provisioning.	up-002axzhapcbz6e63****
NewDuplicationStrategy	string	No	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
NewDeletionStrategy	string	No	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
NewDescription	string	No	The new description of the RAM user provisioning.	description*****

Response elements

Element	Type	Description	Example
	object	The returned results.
UserProvisioning	object	The information about the RAM user provisioning.
Status	string	The status of the RAM user provisioning. Valid values: Enabled Disabled	Enabled
Description	string	The description for the RAM user provisioning.	This is a user provisioning.
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 resource directory in which you create the RAM user provisioning for the object.	rd-****/root/test
UpdateTime	string	The modification time.	2022-11-28T03:55:42Z
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.	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.	testUserName
TargetName	string	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
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.	u-02ha881d*****
CreateTime	string	The creation time.	2022-11-28T03:55:42Z
DirectoryId	string	The ID of the resource directory.	d-003qew84****
OwnerPk	string	The ID of the Alibaba Cloud account to which the resource directory belongs.	164987310*****
TargetType	string	The object for which you create the RAM user provisioning. The value is fixed as `RD-Account`.	RD-Account
PrincipalType	string	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
RequestId	string	The request ID.	F6F90F3D-4502-5877-B80B-97476F6AE2CC

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.