Update

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

POST /api/v1/settings/onboarding

Update

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.OnboardingSettings.Update(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateOnboardingSettingsResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.onboardingSettings.update();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/settings/onboarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "mcpOnboardingGoal": "<string>",
  "mcpOnboardingTargets": {
    "targets": [
      {
        "displayName": "<string>",
        "id": "<string>",
        "mcpServerId": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/settings/onboarding"

payload = {
    "conversationId": "<string>",
    "mcpOnboardingGoal": "<string>",
    "mcpOnboardingTargets": { "targets": [
            {
                "displayName": "<string>",
                "id": "<string>",
                "mcpServerId": "<string>"
            }
        ] }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversationId: '<string>',
    mcpOnboardingGoal: '<string>',
    mcpOnboardingTargets: {targets: [{displayName: '<string>', id: '<string>', mcpServerId: '<string>'}]}
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/settings/onboarding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/settings/onboarding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'conversationId' => '<string>',
    'mcpOnboardingGoal' => '<string>',
    'mcpOnboardingTargets' => [
        'targets' => [
                [
                                'displayName' => '<string>',
                                'id' => '<string>',
                                'mcpServerId' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/settings/onboarding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversationId\": \"<string>\",\n  \"mcpOnboardingGoal\": \"<string>\",\n  \"mcpOnboardingTargets\": {\n    \"targets\": [\n      {\n        \"displayName\": \"<string>\",\n        \"id\": \"<string>\",\n        \"mcpServerId\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/settings/onboarding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conversationId\": \"<string>\",\n  \"mcpOnboardingGoal\": \"<string>\",\n  \"mcpOnboardingTargets\": {\n    \"targets\": [\n      {\n        \"displayName\": \"<string>\",\n        \"id\": \"<string>\",\n        \"mcpServerId\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "mcpOnboardingGoal": "<string>",
  "mcpOnboardingTargets": [
    {
      "displayName": "<string>",
      "id": "<string>",
      "mcpServerId": "<string>"
    }
  ]
}

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.

Body

application/json

The UpdateOnboardingSettingsRequest message.

conversationId · string

The identifier of the onboarding conversation thread to associate.

mcpOnboardingGoal · string | null

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

mcpOnboardingStatus · enum<string> | null

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).

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 List · object | null

McpOnboardingTargetList wraps the target list so an update can distinguish replace (present, even if empty) from leave-unchanged (omitted).

Show child attributes

status · enum<string>

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).

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

Response

200 - application/json

Successful response

The UpdateOnboardingSettingsResponse message.

mcpOnboardingGoal · string

The updated AIAM onboarding goal.

mcpOnboardingStatus · enum<string>

The updated AIAM MCP onboarding 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

The updated AIAM onboarding targets.

Show child attributes

status · enum<string>

The updated onboarding status.

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