Delete Connected Account
Delete a particular connected (linked) account.
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/account-link/connected-accounts/{linkedAccountPathId}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Organization identifier |
| required |
|
string | The linked connected account identifier |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
boolean | When true, forcibly removes a connected account even when SDDC's are still linked to it. |
Response
Response
Response BodyResponse Body
200 OK returns
AwsCustomerConnectedAccount
{
"account_number": "string",
"cf_stack_name": "string",
"created": "string",
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"org_id": "string",
"policy_external_id": "string",
"policy_payer_arn": "string",
"policy_payer_linked_arn": "string",
"policy_service_arn": "string",
"region_to_az_to_shadow_mapping": {
"key": "string"
},
"state": "string",
"updated": "string",
"updated_by_user_id": "string",
"updated_by_user_name": "string",
"user_id": "string",
"user_name": "string",
"version": 5
}| Property Name | Type | Description |
|---|---|---|
| account_number | string | Not available |
| cf_stack_name | string | Not available |
| created | string | Not available |
| id | string |
Unique ID for this entity |
| org_id | string | Not available |
| policy_external_id | string | Not available |
| policy_payer_arn | string | Not available |
| policy_service_arn | string | Not available |
| region_to_az_to_shadow_mapping | map of string |
Provides a map of regions to availability zones from the shadow account’s perspective |
| updated | string | Not available |
| updated_by_user_id | string |
User id that last updated this record |
| user_id | string |
User id that last updated this record |
| user_name | string |
User name that last updated this record |
| version | integer |
Version of this entity |
| policy_payer_linked_arn | string | Not available |
| state | string |
Not available
Possible values are: ACTIVE, BROKEN, DELETED |
| updated_by_user_name | string |
User name that last updated this record |
cURL Command
curl -X DELETE https://vmc.vmware.com/vmc/api/orgs/{org}/account-link/connected-accounts/{linkedAccountPathId}
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Nothing | The request requires user authentication. |
| 403 | Nothing | The server understood the request, but is refusing to fulfill it. |
| 400 | ErrorResponse | The request cannot be fulfilled due to bad syntax. |
On This Page
Connected Accounts Operations
delete
