Troupeby AliveDocsSign in

Reference

orgs

Organizations, the tenant. The creator becomes the first owner. Index · shared schemas · errors.

ProcedureSummaryRESTMCP toolStability
orgs.createCreate an org; the signed-in user becomes its ownerPOST—experimental
orgs.listThe orgs in the caller's view: a user's memberships with their role, or an API key's one orgGET—experimental
orgs.getGet an orgGET—experimental
orgs.updateRename an org or change its slug (CONFLICT when the slug is taken)POST—experimental
orgs.setPlacementScopeSet where the org's work may share a device host: org (its projects in turn; CONFLICT project-placement-in-use while a trusted issuer gives each sub-tenant its own project) or project (each apart; CONFLICT placement-units-required until the org has a placement_units limit, credentials-allow-all-projects while a credential lets every project sign). Owners only, every owner mailed. Trust class.POST—experimental

orgs.create

Create an org; the signed-in user becomes its owner

RESTPOST /v1/orgs/create (input as a JSON body)
RPC/rpc/v2/orgs/create
MCPnot a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: none
Authaccount:write
Tenancynone
Troupe Cloudanswered by the control plane
Stabilityexperimental, since 1.0

Input:

TypeScript
{ name: DisplayName; slug?: Slug }

Output:

TypeScript
{ org: Org }

Errors: U, CONFLICT.

Named types: DisplayName, Org, Slug.

orgs.list

The orgs in the caller's view: a user's memberships with their role, or an API key's one org

RESTGET /v1/orgs/list (input as query parameters)
RPC/rpc/v2/orgs/list
MCPnot a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: read-only, idempotent
Authsession: any authenticated principal, no scope check
Tenancynone
Troupe Cloudanswered by the control plane
Stabilityexperimental, since 1.0

Input:

TypeScript
{}

Output:

TypeScript
{ orgs: Org[] }

Errors: U.

Named types: Org.

orgs.get

Get an org

RESTGET /v1/orgs/get (input as query parameters)
RPC/rpc/v2/orgs/get
MCPnot a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: read-only, idempotent
Authorg:read
Tenancyorg
Troupe Cloudanswered by the control plane
Stabilityexperimental, since 1.0

Input:

TypeScript
{ orgId: OrgId }

Output:

TypeScript
{ org: Org }

Errors: U, NOT_FOUND.

Named types: Org, OrgId.

orgs.update

Rename an org or change its slug (CONFLICT when the slug is taken)

RESTPOST /v1/orgs/update (input as a JSON body)
RPC/rpc/v2/orgs/update
MCPnot a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: idempotent
Authorg:manage
Tenancyorg
Troupe Cloudanswered by the control plane
Stabilityexperimental, since 1.0

Input:

TypeScript
{ orgId: OrgId; name?: DisplayName; slug?: Slug }

Output:

TypeScript
{ org: Org }

Errors: U, NOT_FOUND, ORG_SUSPENDED, CONFLICT.

Named types: DisplayName, Org, OrgId, Slug.

orgs.setPlacementScope

Set where the org's work may share a device host: org (its projects in turn; CONFLICT project-placement-in-use while a trusted issuer gives each sub-tenant its own project) or project (each apart; CONFLICT placement-units-required until the org has a placement_units limit, credentials-allow-all-projects while a credential lets every project sign). Owners only, every owner mailed. Trust class.

RESTPOST /v1/orgs/set-placement-scope (input as a JSON body)
RPC/rpc/v2/orgs/setPlacementScope
MCPnot a tool (a cloud platform procedure; the cloud MCP surface is the curated device tools); hints: idempotent
Authorg:manage; trust-class: locally only the runtime owner token; in the cloud only an interactive user session re-authenticated within 15 minutes; never an API key or an MCP token
Tenancyorg
Troupe Cloudanswered by the control plane
Stabilityexperimental, since 1.0

Input:

TypeScript
{ orgId: OrgId; placementScope: 'org' | 'project' }

Output:

TypeScript
{ org: Org }

Errors: U, NOT_FOUND, ORG_SUSPENDED, CONFLICT.

Named types: Org, OrgId.

esc

    Type to search every page, the protocol reference and the cloud API.