Skip to content
Start here

Tenant Structures

List tenant structures for an account
GET/accounts/{account_id}/cws/tenant-structures
Get a tenant structure by ID
GET/accounts/{account_id}/cws/tenant-structures/{structure_id}
Create a tenant structure
POST/accounts/{account_id}/cws/tenant-structures
Update a tenant structure
PUT/accounts/{account_id}/cws/tenant-structures/{structure_id}
Delete a tenant structure
DELETE/accounts/{account_id}/cws/tenant-structures/{structure_id}
ModelsExpand Collapse
TenantStructure object { id, application, created_at, 3 more }
id: string

Server-assigned UUID

formatuuid
application: "aws" or "cloudflare"

Platform this structure models. Immutable after creation; determines valid node kinds and identifier formats.

One of the following:
"aws"
"cloudflare"
created_at: string
formatdate-time
name: string

Human-readable name; unique per account

maxLength100
minLength1
updated_at: string
formatdate-time
import_path: optional string

Optional unique Rego mount path in the form tenant... The application segment must match application; omitted when unmounted.

maxLength255
minLength1
TenantStructureDeleteResponse object { id }
id: string
formatuuid

Tenant StructuresNodes

List nodes for a tenant structure
GET/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes
Get a tenant node by ID
GET/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}
Add a node to a tenant structure
POST/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes
Update a tenant node
PUT/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}
Delete a tenant node
DELETE/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/{node_id}
Apply a batch of tenant node mutations
POST/accounts/{account_id}/cws/tenant-structures/{structure_id}/nodes/batch
ModelsExpand Collapse
TenantStructureNode object { id, created_at, native_id, 4 more }
id: string

Server-assigned UUID

formatuuid
created_at: string
formatdate-time
native_id: string

Cloud-native identifier of this node, unique within the structure; the parent-reference target. Shape depends on the structure’s application. Immutable after create.

maxLength255
minLength1
node_kind: string

Position in the tree. Legal values depend on the structure’s application (aws: root/ou/account; cloudflare: org/account/zone). At most one root per structure. Immutable after create.

maxLength64
minLength1
updated_at: string
formatdate-time
name: optional string

Display name (e.g. an OU or account name), mutable. Optional; empty by default.

maxLength100
parent: optional string

Native ID of this node’s parent. Required for non-root nodes and omitted for the root. The parent must be in the same structure and able to contain this node kind.

maxLength255
NodeDeleteResponse object { id }
id: string
formatuuid
NodeBatchResponse object { created, deleted, updated }
created: array of TenantStructureNode { id, created_at, native_id, 4 more }
id: string

Server-assigned UUID

formatuuid
created_at: string
formatdate-time
native_id: string

Cloud-native identifier of this node, unique within the structure; the parent-reference target. Shape depends on the structure’s application. Immutable after create.

maxLength255
minLength1
node_kind: string

Position in the tree. Legal values depend on the structure’s application (aws: root/ou/account; cloudflare: org/account/zone). At most one root per structure. Immutable after create.

maxLength64
minLength1
updated_at: string
formatdate-time
name: optional string

Display name (e.g. an OU or account name), mutable. Optional; empty by default.

maxLength100
parent: optional string

Native ID of this node’s parent. Required for non-root nodes and omitted for the root. The parent must be in the same structure and able to contain this node kind.

maxLength255
deleted: array of object { id }
id: string
formatuuid
updated: array of TenantStructureNode { id, created_at, native_id, 4 more }
id: string

Server-assigned UUID

formatuuid
created_at: string
formatdate-time
native_id: string

Cloud-native identifier of this node, unique within the structure; the parent-reference target. Shape depends on the structure’s application. Immutable after create.

maxLength255
minLength1
node_kind: string

Position in the tree. Legal values depend on the structure’s application (aws: root/ou/account; cloudflare: org/account/zone). At most one root per structure. Immutable after create.

maxLength64
minLength1
updated_at: string
formatdate-time
name: optional string

Display name (e.g. an OU or account name), mutable. Optional; empty by default.

maxLength100
parent: optional string

Native ID of this node’s parent. Required for non-root nodes and omitted for the root. The parent must be in the same structure and able to contain this node kind.

maxLength255
⌂ 换网址