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
    }
}

200

{
  "status": "ONBOARDING_STATUS_UNSPECIFIED"
}

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.

status · enum<string>

The new onboarding status to set.

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.

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