Files
codex/codex-rs/app-server-protocol/schema/json/v2/AccountUpdatedNotification.json
T
JonLuca De Caro 67d8266e06 Signal workspace routing readiness in account updates (#62145)
## Why

App-server clients receive `account/updated` both when routing is ready
for a saved ChatGPT workspace and when a user logs in, logs out, or
switches workspaces. The notification payload gives clients no explicit
way to identify the initial routing update.

## What changed

Add a nullable `reason` to `account/updated`. Set it to
`workspaceRoutingReady` on the initial saved-workspace routing
notification when the authenticated owner is unchanged, including when
routing is ready before the connection initializes. Login, logout, and
workspace-switch updates send `null`. Update the protocol schemas,
TypeScript types, and Python SDK models.

## Testing

Extend the app-server integration tests to check the reason in the JSON
payloads for saved-workspace discovery, login, workspace switching, and
logout.

GitOrigin-RevId: 96758519985a6bdb07474e48307ed53b125823ee
2026-11-18 00:46:17 +00:00

133 lines
3.1 KiB
JSON
Generated

{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"AccountUpdateReason": {
"enum": [
"workspaceRoutingReady",
"unknown"
],
"type": "string"
},
"AuthMode": {
"description": "Authentication mode for OpenAI-backed providers.",
"oneOf": [
{
"description": "OpenAI API key provided by the caller and stored by Codex.",
"enum": [
"apikey"
],
"type": "string"
},
{
"description": "ChatGPT OAuth managed by Codex (tokens persisted and refreshed by Codex).",
"enum": [
"chatgpt"
],
"type": "string"
},
{
"description": "[UNSTABLE] FOR OPENAI INTERNAL USE ONLY - DO NOT USE.\n\nChatGPT auth tokens are supplied by an external host app and are only stored in memory. Token refresh must be handled by the external host app.",
"enum": [
"chatgptAuthTokens"
],
"type": "string"
},
{
"description": "Backend auth supplied as request headers.",
"enum": [
"headers"
],
"type": "string"
},
{
"description": "Programmatic Codex auth backed by a registered Agent Identity.",
"enum": [
"agentIdentity"
],
"type": "string"
},
{
"description": "Programmatic Codex auth backed by a personal access token.",
"enum": [
"personalAccessToken"
],
"type": "string"
},
{
"description": "Amazon Bedrock bearer token managed by Codex.",
"enum": [
"bedrockApiKey"
],
"type": "string"
},
{
"description": "Amazon Bedrock AWS access keys managed by Codex.",
"enum": [
"bedrockAccessKeys"
],
"type": "string"
}
]
},
"PlanType": {
"enum": [
"free",
"go",
"plus",
"pro",
"prolite",
"promax",
"team",
"self_serve_business_prolite",
"self_serve_business_usage_based",
"business",
"ent26",
"enterprise_cbp_automation",
"enterprise_cbp_usage_based",
"enterprise",
"edu",
"edu_plus",
"edu_pro",
"sci",
"sci_plus",
"unknown"
],
"type": "string"
}
},
"properties": {
"authMode": {
"anyOf": [
{
"$ref": "#/definitions/AuthMode"
},
{
"type": "null"
}
]
},
"planType": {
"anyOf": [
{
"$ref": "#/definitions/PlanType"
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"$ref": "#/definitions/AccountUpdateReason"
},
{
"type": "null"
}
],
"description": "Set when initial routing discovery completes for the same authenticated owner."
}
},
"title": "AccountUpdatedNotification",
"type": "object"
}