CreateAccessAssignment - CloudSSO - Alibaba Cloud Documentation Center

Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.

Operation description

When you call this operation, an asynchronous task is created. You can call the GetTask operation to query the progress of the task based on the value of the TaskId response parameter.

For more information about how to assign permissions on an account in your resource directory, see Overview of multi-account authorization.

This topic provides an example on how to assign access permissions on the account 114240524784**** in your resource directory to the CloudSSO user u-00q8wbq42wiltcrk**** by using the access configuration ac-00jhtfl8thteu6uj****. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:CreateAccessAssignment	Write	AccessConfiguration acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/{#AccessConfigurationId} User acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/{#UserId} Group acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/{#GroupId} Account acs:resourcemanager::{#accountId}:account/{#AccountId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****
AccessConfigurationId	string	Yes	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
TargetType	string	Yes	The type of the task object. Set the value to RD-Account, which specifies the accounts in the resource directory.	RD-Account
TargetId	string	Yes	The ID of the task object.	114240524784****
PrincipalType	string	Yes	The type of the CloudSSO identity. Valid values: User Group	User
PrincipalId	string	Yes	The ID of the CloudSSO identity. If you set `PrincipalType` to `User`, set `PrincipalId` to the ID of the CloudSSO user. If you set `PrincipalType` to `Group`, set `PrincipalId` to the ID of the CloudSSO group.	u-00q8wbq42wiltcrk****

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
Task	object	The queried task.
Status	string	The task status. Valid values: InProgress: The task is running. Success: The task is successful. Failed: The task failed.	InProgress
TaskId	string	The ID of the job.	t-sh6tceylhvgejpip****
PrincipalId	string	The ID of the CloudSSO identity.	u-00q8wbq42wiltcrk****
TargetPath	string	The path ID of the task object in the resource directory.	rd-3G**/r-Wm/114240524784**
PrincipalName	string	The name of the CloudSSO identity.	Alice
TargetName	string	The name of the task object.	dev-test
TargetId	string	The ID of the task object.	114240524784****
AccessConfigurationName	string	The name of the access configuration.	ECS-Admin
TargetPathName	string	The path name of the task object in the resource directory.	rd-3G****/root/dev-test
TaskType	string	The task type. The value is fixed as CreateAccessAssignment, which indicates that access permissions on an account in your resource directory are assigned.	CreateAccessAssignment
TargetType	string	The type of the task object. The value is fixed as RD-Account, which indicates the accounts in the resource directory.	RD-Account
AccessConfigurationId	string	The ID of the access configuration.	ac-00jhtfl8thteu6uj****
PrincipalType	string	The type of the CloudSSO identity. Valid values: User Group	User
RequestId	string	The request ID.	4726AA56-E138-5C99-85E4-F493536D042F

Examples

Sample success responses

JSONformat

{
  "Task": {
    "Status": "InProgress",
    "TaskId": "t-sh6tceylhvgejpip****",
    "PrincipalId": "u-00q8wbq42wiltcrk****",
    "TargetPath": "rd-3G****/r-Wm****/114240524784****",
    "PrincipalName": "Alice",
    "TargetName": "dev-test",
    "TargetId": "114240524784****",
    "AccessConfigurationName": "ECS-Admin",
    "TargetPathName": "rd-3G****/root/dev-test",
    "TaskType": "CreateAccessAssignment",
    "TargetType": "RD-Account",
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
    "PrincipalType": "User"
  },
  "RequestId": "4726AA56-E138-5C99-85E4-F493536D042F"
}

Error codes

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