Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Response

200 - application/json

Successful response

The GetOnboardingSettingsResponse message.

conversationId
string

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

intents
string[] | null

The intents field.

mcpOnboardingGoal
string

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

mcpOnboardingStatus
enum<string>

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

Available options:
MCP_ONBOARDING_STATUS_UNSPECIFIED,
MCP_ONBOARDING_STATUS_NOT_STARTED,
MCP_ONBOARDING_STATUS_IN_PROGRESS,
MCP_ONBOARDING_STATUS_COMPLETE,
MCP_ONBOARDING_STATUS_DISMISSED
mcpOnboardingTargets
Mcp Onboarding Target · object[] | null

Per-target progress of the AIAM briefing: the servers/apps the admin chose to govern and how far each got.

orgContext
Onboarding Org Context · object | null

The OnboardingOrgContext message.

status
enum<string>

The current status of the tenant onboarding process.

Available options:
ONBOARDING_STATUS_UNSPECIFIED,
ONBOARDING_STATUS_NOT_STARTED,
ONBOARDING_STATUS_IN_PROGRESS,
ONBOARDING_STATUS_COMPLETE,
ONBOARDING_STATUS_DISMISSED