Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-216381,9552.9 MB

f2cf3228f366

Onboarding Settings

Update

Update modifies the onboarding progress, such as marking steps complete or dismissing the wizard.

post/api/v1/settings/onboarding

Request body

conversationIdstring

The identifier of the onboarding conversation thread to associate.

mcpOnboardingGoalstring nullable

The admin's AIAM onboarding goal. Omit to leave unchanged; set to "" to clear.

mcpOnboardingStatus'MCP_ONBOARDING_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_STATUS_NOT_STARTED' | 'MCP_ONBOARDING_STATUS_IN_PROGRESS' | 'MCP_ONBOARDING_STATUS_COMPLETE' | 'MCP_ONBOARDING_STATUS_DISMISSED' nullable

The new MCP onboarding status to set. Omit (or UNSPECIFIED) to leave it unchanged. Setting NOT_STARTED restarts the briefing and clears the stored mcp_onboarding_goal and mcp_onboarding_targets, unless this same request also sets them (those win).

status'ONBOARDING_STATUS_UNSPECIFIED' | 'ONBOARDING_STATUS_NOT_STARTED' | 'ONBOARDING_STATUS_IN_PROGRESS' | 'ONBOARDING_STATUS_COMPLETE' | 'ONBOARDING_STATUS_DISMISSED'

The new onboarding status to set. UNSPECIFIED leaves the core onboarding status unchanged (set mcp_onboarding_status alone to retire the AIAM briefing without touching the core wizard).

Response

Successful response

mcpOnboardingGoalstring

The updated AIAM onboarding goal.

mcpOnboardingStatus'MCP_ONBOARDING_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_STATUS_NOT_STARTED' | 'MCP_ONBOARDING_STATUS_IN_PROGRESS' | 'MCP_ONBOARDING_STATUS_COMPLETE' | 'MCP_ONBOARDING_STATUS_DISMISSED'

The updated AIAM MCP onboarding status.

status'ONBOARDING_STATUS_UNSPECIFIED' | 'ONBOARDING_STATUS_NOT_STARTED' | 'ONBOARDING_STATUS_IN_PROGRESS' | 'ONBOARDING_STATUS_COMPLETE' | 'ONBOARDING_STATUS_DISMISSED'

The updated onboarding status.