Creates a new cloud org

Creates a new cloud org

Query Parameters

dryRun string

Set to 'All' to perform a server-side dry run of creating this resource

owner string

Set an explicit owner for this resource

application/json

Request Body required

The specification for the cloud org you are creating

apiVersion string
kind 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
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
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
property name* string
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.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
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.
apiVersion stringrequired
blockOwnerDeletion boolean
controller boolean
kind stringrequired
name stringrequired
uid stringrequired
resourceVersion string
selfLink string
uid string
spec
CloudOrgSpec defines the specification of an org to use for factorying cloud accounts
accountIdentifier stringrequired
allocation required
Allocation describes which workspaces can use this cloud org.
type stringrequired
workspaces string[]
cloud stringrequired
defaultRegion string
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.
name stringrequired
namespace stringrequired
name stringrequired
namingRules undefined[]
NamingRules describes how to name child accounts based on the plan chosen. account.
description string
name stringrequired
prefix string
stages string[]required
suffix string
orgIdentifier stringrequired
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.
ouName stringrequired
region stringrequired
ssoUser required
SSOUser is the user who will be the organisational account owner for all accounts. Required before this organization can be used
email stringrequired
firstName stringrequired
lastName stringrequired
userRoles object
UserRoles contains the ARNs of stacksets to create instances of in each managed account
property name* string
azure
Azure holds parameters specific to Azure tenant accounts. Present only if type is Azure.
agreementType stringrequired
billingAccount stringrequired
billingProfile string
contributorObjectID string
enrollmentAccount string
invoiceSection string
managementGroupID string
ownerObjectID stringrequired
gcp
GCP holds parameters specific to GCP organization accounts. Present only if type is GCP.
billingAccount stringrequired
parentType stringrequired
type stringrequired
roles undefined[]
Roles defines a set of identities which Wayfinder should assume in order to perform account management functionality.
assumeProviderRole string
cloudResourceName stringrequired
deployedResourceHash string
role stringrequired
stages string[]
status
CloudOrgStatus defines the status of a cloud org
cloudResourcesCreated boolean
conditions undefined[]
detail string
lastTransitionTime stringrequired
message string
name stringrequired
negativePolarity boolean
observedGeneration int64
reason stringrequired
status stringrequired
type stringrequired
detail string
lastReconcile
generation int64required
time stringrequired
lastSuccess
generation int64required
time stringrequired
message string
obsoleteResources undefined[]
kind stringrequired
name stringrequired
status stringrequired
wayfinderVersion string

Responses

200

Contains the cloud org definition

application/json

Schema

Schema

apiVersion string
kind 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
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
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
property name* string
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.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
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.
apiVersion string
blockOwnerDeletion boolean
controller boolean
kind string
name string
uid string
resourceVersion string
selfLink string
uid string
spec
CloudOrgSpec defines the specification of an org to use for factorying cloud accounts
accountIdentifier string
allocation
Allocation describes which workspaces can use this cloud org.
type string
workspaces string[]
cloud string
defaultRegion string
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.
name string
namespace string
name string
namingRules undefined[]
NamingRules describes how to name child accounts based on the plan chosen. account.
description string
name string
prefix string
stages string[]
suffix string
orgIdentifier string
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.
ouName string
region string
ssoUser
SSOUser is the user who will be the organisational account owner for all accounts. Required before this organization can be used
email string
firstName string
lastName string
userRoles object
UserRoles contains the ARNs of stacksets to create instances of in each managed account
property name* string
azure
Azure holds parameters specific to Azure tenant accounts. Present only if type is Azure.
agreementType string
billingAccount string
billingProfile string
contributorObjectID string
enrollmentAccount string
invoiceSection string
managementGroupID string
ownerObjectID string
gcp
GCP holds parameters specific to GCP organization accounts. Present only if type is GCP.
billingAccount string
parentType string
type string
roles undefined[]
Roles defines a set of identities which Wayfinder should assume in order to perform account management functionality.
assumeProviderRole string
cloudResourceName string
deployedResourceHash string
role string
stages string[]
status
CloudOrgStatus defines the status of a cloud org
cloudResourcesCreated boolean
conditions undefined[]
detail string
lastTransitionTime string
message string
name string
negativePolarity boolean
observedGeneration int64
reason string
status string
type string
detail string
lastReconcile
generation int64
time string
lastSuccess
generation int64
time string
message string
obsoleteResources undefined[]
kind string
name string
status string
wayfinderVersion string

Example (from schema)

{
  "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"
  }
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32
fieldErrors undefined[]
errCode string
field string
message string
message string

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32
detail string
message string
uri string
verb string

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...