Delete Connected Accounts
Delete a particular connected (linked) account.
Request
URI
DELETE
https://{api_host}/vmc/api/orgs/{org}/account-link/connected-accounts/{linkedAccountPathId}
COPY
Path Parameters
string
org
Required
Organization identifier.
string
linkedAccountPathId
Required
The linked connected account identifier
Query Parameters
boolean
forceEvenWhenSddcPresent
Optional
When true, forcibly removes a connected account even when SDDC's are still linked to it.
Responses
200
OK
Returns
AwsCustomerConnectedAccount
of type(s)
application/json
This response body class contains all of the following:
InlineAwsCustomerConnectedAccount0
{
"updated": "string",
"user_id": "string",
"updated_by_user_id": "string",
"created": "string",
"version": 5,
"updated_by_user_name": "string",
"user_name": "string",
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"policy_payer_arn": "string",
"region_to_az_to_shadow_mapping": {
"region_to_az_to_shadow_mapping": {
"region_to_az_to_shadow_mapping": "string"
}
},
"org_id": "string",
"cf_stack_name": "string",
"state": "string",
"account_number": "string",
"policy_service_arn": "string",
"policy_external_id": "string",
"policy_payer_linked_arn": "string"
}
400
An invalid connected account ID was specified, or the connection still has SDDCs active on it.
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
integer
status
Required
HTTP status code
string
path
Required
Originating request URI
boolean
retryable
Required
If true, client should retry operation
string
error_code
Required
unique error code
array of
string
error_messages
Required
localized error messages
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
Code Samples
COPY
curl -X DELETE -H 'Authorization: <value>' https://{api_host}/vmc/api/orgs/{org}/account-link/connected-accounts/{linkedAccountPathId}