App tokens
4 methods on the App tokens resource.
4 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";4 of 4
createAppToken
Create an app token and reveal its bearer secret once
compozy.appTokens.createAppToken({ body }) → Promise<AppTokenIssuedResponse>
Request bodyCreateAppTokenRequest
POST /api/app-tokensapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.appTokens.createAppToken({ body: { /* request fields */ } });listAppTokens
List app tokens without their bearer secrets
compozy.appTokens.listAppTokens({ query }) → Promise<AppTokensResponse>
Options
- state"active" | "revoked" | "all"query
- Token state; defaults to active
GET /api/app-tokensapp tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.appTokens.listAppTokens();revokeAppToken
Revoke an app token and cancel its active streams
compozy.appTokens.revokeAppToken({ path }) → Promise<AppTokenRevokeResponse>
Options
- app_token_idstringpathrequired
- App token id
DELETE /api/app-tokens/{app_token_id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.appTokens.revokeAppToken({ path: { "app_token_id": "app_token_id" } });updateAppToken
Change an app token name or replace its origin allowlist
compozy.appTokens.updateAppToken({ path, body }) → Promise<AppTokenResponse>
Options
- app_token_idstringpathrequired
- App token id
Request bodyUpdateAppTokenRequest
PATCH /api/app-tokens/{app_token_id}app tokens denied
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.appTokens.updateAppToken({ path: { "app_token_id": "app_token_id" }, body: { /* request fields */ } });