x-cpod-domain: apps

Apps

App identity registry, admin catalog RBAC (roles + group mappings), and runtime install view for effective permissions.

Try in explorer client.apps

App

A registered application identity with its own app_id used for MCP tool registration.

REST path/api/v1/apps

Operations

registermeregisterToolslistTools

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
app_id*	uuid	Platform-assigned application identity.
name*	string	Application name.
description	string	Application description and capabilities.
status	enum	Application status.`activeinactiverevoked`
created_at*	date-time	Registration timestamp.

CatalogApp

Admin catalog app with roles[] and requested_permissions. Use create/list for setup; distinct from apps.register identity.

REST path/api/v1/apps

Operations

createlist

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

// create:
await client.apps.create({
  app_code: "example app_code",
  name: "example name",
})

Field	Type	Description
app_code*	string	Stable slug (e.g. project-hub).
name*	string	Display name.
roles	json	In-app role definitions: key, name, permissions[].
requested_permissions	json	Install permission ceiling.

RoleMappings

Tenant group/user → in-app role mappings on the install document.

REST path/api/v1/apps/{appId}/role-mappings

Operations

getRoleMappingssetRoleMappings

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
principal_type*	enum	Mapping principal kind.`groupuser`
principal_id*	string	Group or user id.
role*	string	In-app role key (not a platform role).

AppInstallView

Runtime effective role and permissions for the calling user (after setup). Query by app_code.

REST path/api/v1/app-install

Operations

getInstallView

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
app_code*	string	App slug passed as query app_code.
role	string	Primary matched in-app role.
roles	json	All matched role keys.
permissions	json	Effective permissions after grant intersection.

AppContext

Short-lived signed platform context for app runtime / MCP.

REST path/api/v1/apps/{appId}/context

Operations

mintContext

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
signature*	string	HMAC-SHA256 signature.
expires_at*	string	Expiry (epoch seconds as string).
permissions	json	Effective permissions baked into context.

AppReconsent

Approve pending permission-expansion reconsent for a tenant install.

REST path/api/v1/apps/{appId}/reconsent

Operations

approveReconsent

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
reconsent_required*	boolean	False after approval.
granted_permissions	json	Updated grant set when approved.

AppInstallsDashboard

Cross-tenant installs view (global_admin).

REST path/api/v1/apps/{appId}/installs

Operations

listInstalls

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
installs*	json	Per-tenant install rows with role_mappings.
reconsent_required	boolean	Pending reconsent flag.

AppMcpTool

An MCP tool registered under an application identity.

REST path/api/v1/apps/{appId}/mcp/tools

Operations

registerToolslistTools

SDK

// list — returns only your records; add filters/search:
await client.apps.list()

Field	Type	Description
name*	string	Tool name (unique per app).
description*	string	Tool description for LLM consumption.
endpoint*	string	REST endpoint this tool proxies.
method*	enum	HTTP method.`GETPOSTPUTPATCHDELETE`
input_schema	json	JSON Schema for tool input arguments.

Docs

App

CatalogApp

RoleMappings

AppInstallView

AppContext

AppReconsent

AppInstallsDashboard

AppMcpTool