CreateUserProvisioning - CloudSSO - Alibaba Cloud Documentation Center

Creates a Resource Access Management (RAM) user provisioning.

Operation description

You can create a RAM user provisioning for a member in your resource directory to create a RAM user that has the same username as a CloudSSO user. This way, the CloudSSO user can access the resources of the member as the RAM user.

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
DirectoryId	string	Yes	The ID of the resource directory.	d-003qew84****
DuplicationStrategy	string	Yes	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	Yes	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
Description	string	No	The description.	This is a user provisioning.
PrincipalId	string	Yes	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*****
PrincipalType	string	Yes	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
TargetId	string	Yes	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******
TargetType	string	Yes	The object for which you create the RAM user provisioning. The value is fixed as `RD-Account`.	RD-Account

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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.	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 member.	rd-****/root/test
UpdateTime	string	The modification time. The time is displayed in UTC.	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.	testGroupName
TargetName	string	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.	testTargetName
TargetId	string	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******
CreateTime	string	The creation time. The time is displayed in UTC.	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.	1639738******
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: 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
RequestId	string	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": "testGroupName",
    "TargetName": "testTargetName",
    "TargetId": "1743382******",
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-003qew84****",
    "OwnerPk": "1639738******",
    "TargetType": "RD-Account",
    "PrincipalType": "Group"
  },
  "RequestId": "F6F90F3D-4502-5877-B80B-97476F6AE2CC"
}

Error codes

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