DeprovisionAccessConfiguration - CloudSSO - Alibaba Cloud Documentation Center

De-provisions an access configuration from an account in your resource directory.

Operation description

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

This topic provides an example on how to de-provision the access configuration ac-00jhtfl8thteu6uj**** from the account 114240524784**** in your 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:DeprovisionAccessConfiguration	Write	AccessConfiguration acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/{#AccessConfigurationId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The directory ID.	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****

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
Tasks	object []	The task information.
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 task ID.	t-sh0655wnq8pdlrlc****
TargetPath	string	The path ID of the task object in the resource directory.	rd-3G**/r-Wm/114240524784**
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 DeprovisionAccessConfiguration, which indicates that the access configuration is de-provisioned.	DeprovisionAccessConfiguration
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****
RequestId	string	The request ID.	584FE9D0-D1AC-5B19-A39C-8D244FC0538C

Examples

Sample success responses

JSONformat

{
  "Tasks": [
    {
      "Status": "InProgress",
      "TaskId": "t-sh0655wnq8pdlrlc****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "TargetName": "dev-test",
      "TargetId": "114240524784****",
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "TaskType": "DeprovisionAccessConfiguration",
      "TargetType": "RD-Account",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****"
    }
  ],
  "RequestId": "584FE9D0-D1AC-5B19-A39C-8D244FC0538C"
}

Error codes

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