Sign in
Onboarding Settings

Get

Get retrieves the current onboarding progress for the tenant.

get/api/v1/settings/onboarding

Response

Successful response

conversationIdstring

The identifier of the onboarding conversation thread, if one is in progress.

intentsstring[] nullable

The intents field.

mcpOnboardingGoalstring

The admin's free-form AIAM onboarding goal, captured at the Goals step.

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

The current status of the AIAM MCP onboarding briefing, tracked independently of status.

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

The current status of the tenant onboarding process.

Changes