Deletes the cloud org
Deletes the cloud org
Path Parameters
The name of the cloud org you wish to delete
Query Parameters
Set to 'All' to perform a server-side dry run of deleting this resource
Set to 'true' to override read-only (has no effect unless used by Wayfinder admin)
Use an explicit owner when deleting - this must match the owner used on create, if set
If true then all objects owned by this object will be deleted too.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Contains the cloud org definition
- application/json
- Schema
- Example (from schema)
Schema
property name*
stringproperty name*
stringproperty name*
string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
spec
CloudOrgSpec defines the specification of an org to use for factorying cloud accounts
allocation
Allocation describes which workspaces can use this cloud org.
identityCred
IdentityCred is a reference to the credential for Wayfinder to identify itself to this cloud provider when using this organization.
Will be populated by Wayfinder with the default identity cred for this cloud if unspecified on entry.
namingRules undefined[]
NamingRules describes how to name child accounts based on the plan chosen. account.
providerDetails
ProviderDetails provides additional fields which can be used for cloud-provider specific data, such as a GCP billing account ID.
aws
AWS holds parameters specific to AWS organization accounts. Present only if type is AWS.
ssoUser
SSOUser is the user who will be the organisational account owner for all accounts. Required before this organization can be used
userRoles object
UserRoles contains the ARNs of stacksets to create instances of in each managed account
azure
Azure holds parameters specific to Azure tenant accounts. Present only if type is Azure.
gcp
GCP holds parameters specific to GCP organization accounts. Present only if type is GCP.
roles undefined[]
Roles defines a set of identities which Wayfinder should assume in order to perform account management functionality.
status
CloudOrgStatus defines the status of a cloud org
conditions undefined[]
lastReconcile
lastSuccess
obsoleteResources undefined[]
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"clusterName": "string",
"creationTimestamp": "string",
"deletionGracePeriodSeconds": 0,
"deletionTimestamp": "string",
"finalizers": [
"string"
],
"generateName": "string",
"generation": 0,
"labels": {},
"managedFields": [
{
"apiVersion": "string",
"fieldsType": "string",
"fieldsV1": "string",
"manager": "string",
"operation": "string",
"subresource": "string",
"time": "string"
}
],
"name": "string",
"namespace": "string",
"ownerReferences": [
{
"apiVersion": "string",
"blockOwnerDeletion": true,
"controller": true,
"kind": "string",
"name": "string",
"uid": "string"
}
],
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"accountIdentifier": "string",
"allocation": {
"type": "string",
"workspaces": [
"string"
]
},
"cloud": "string",
"defaultRegion": "string",
"identityCred": {
"name": "string",
"namespace": "string"
},
"name": "string",
"namingRules": [
{
"description": "string",
"name": "string",
"prefix": "string",
"stages": [
"string"
],
"suffix": "string"
}
],
"orgIdentifier": "string",
"providerDetails": {
"aws": {
"ouName": "string",
"region": "string",
"ssoUser": {
"email": "string",
"firstName": "string",
"lastName": "string"
},
"userRoles": {}
},
"azure": {
"agreementType": "string",
"billingAccount": "string",
"billingProfile": "string",
"contributorObjectID": "string",
"enrollmentAccount": "string",
"invoiceSection": "string",
"managementGroupID": "string",
"ownerObjectID": "string"
},
"gcp": {
"billingAccount": "string",
"parentType": "string"
},
"type": "string"
},
"roles": [
{
"assumeProviderRole": "string",
"cloudResourceName": "string",
"deployedResourceHash": "string",
"role": "string"
}
],
"stages": [
"string"
]
},
"status": {
"cloudResourcesCreated": true,
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"detail": "string",
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"status": "string",
"wayfinderVersion": "string"
}
}
Validation error of supplied parameters/body
- application/json
- Schema
- Example (from schema)
Schema
fieldErrors undefined[]
{
"code": 0,
"fieldErrors": [
{
"errCode": "string",
"field": "string",
"message": "string"
}
],
"message": "string"
}
If not authenticated
If authenticated but not authorized
the cloud org with the given name doesn't exist
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}