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

Usage notes

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.

Limits

You can call this operation up to 20 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeprovisionAccessConfiguration

The operation that you want to perform. Set the value to DeprovisionAccessConfiguration.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

AccessConfigurationId String Yes ac-00jhtfl8thteu6uj****

The ID of the access configuration.

TargetType String Yes RD-Account

The type of the task object. Set the value to RD-Account, which indicates an account in your resource directory.

TargetId String Yes 114240524784****

The ID of the task object.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Tasks Array of Task

The information about the task.

Status String InProgress

The status of the task. Valid values:

  • InProgress: The task is running.
  • Success: The task is successful.
  • Failed: The task failed.
TaskId String t-sh0655wnq8pdlrlc****

The ID of the task.

TargetPath String rd-3G****/r-Wm****/114240524784****

The path ID of the task object in your resource directory.

TargetName String dev-test

The name of the task object.

TargetId String 114240524784****

The ID of the task object.

AccessConfigurationName String ECS-Admin

The name of the access configuration.

TargetPathName String rd-3G****/root/dev-test

The path name of the task object in your resource directory.

TaskType String DeprovisionAccessConfiguration

The type of the task. The value is fixed as DeprovisionAccessConfiguration, which indicates that the access configuration is de-provisioned.

TargetType String RD-Account

The type of the task object. The value is fixed as RD-Account, which indicates an accounts in your resource directory.

AccessConfigurationId String ac-00jhtfl8thteu6uj****

The ID of the access configuration.

RequestId String 584FE9D0-D1AC-5B19-A39C-8D244FC0538C

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=DeprovisionAccessConfiguration
&DirectoryId=d-00fc2p61****
&AccessConfigurationId=ac-00jhtfl8thteu6uj****
&TargetType=RD-Account
&TargetId=114240524784****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DeprovisionAccessConfigurationResponse>
	<Tasks>
		<Task>
			<Status>InProgress</Status>
			<AccessConfigurationName>ECS-Admin</AccessConfigurationName>
			<TaskId>t-sh0655wnq8pdlrlc****</TaskId>
			<TargetPathName>rd-3G****/root/dev-test</TargetPathName>
			<TargetPath>rd-3G****/r-Wm****/114240524784****</TargetPath>
			<TaskType>DeprovisionAccessConfiguration</TaskType>
			<TargetType>RD-Account</TargetType>
			<TargetName>dev-test</TargetName>
			<AccessConfigurationId>ac-00jhtfl8thteu6uj****</AccessConfigurationId>
			<TargetId>114240524784****</TargetId>
		</Task>
	</Tasks>
	<RequestId>584FE9D0-D1AC-5B19-A39C-8D244FC0538C</RequestId>
</DeprovisionAccessConfigurationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.