Get

Get retrieves the current onboarding progress for the tenant.

GET /api/v1/settings/onboarding

Get

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.Get(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.GetOnboardingSettingsResponse != nil {
        // handle response
    }
}

200

{
  "conversationId": "<string>",
  "intents": [
    "<string>"
  ],
  "orgContext": {
    "industry": "<string>",
    "organizationSize": "<string>"
  },
  "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.

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.

orgContext · Onboarding Org Context · object

The OnboardingOrgContext message.

Show child attributes

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