Skip to content
CantoraAPI documentation
POST
/v1/bootstrap

Create Cantora's Organization, its provisioning ServicePrincipal, and its credential

Perform the one-time platform bootstrap and return the provisioning API key exactly once. This operation is for Cantora operators, not customer credentials.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

This operation has no path or query parameters.

Responses

201PlatformBootstrapped
application/json
PlatformBootstrappedJsonEncoding
401Unauthorized
application/json
UnauthorizedJsonEncoding
403Forbidden
application/json
ForbiddenJsonEncoding

Reusable schemas

PlatformBootstrappedJsonEncoding

object
  • unknown properties allowed false
organizationIdrequired
stringThe Organization identifier.
All of
  • maximum length 64
A Cantora Organization identifier, prefixed with `org_`.
  • pattern ^org_[\s\S]+$
organizationNamerequired
stringThe customer-facing Organization name.
principalIdrequired
stringThe Principal identifier.
All of
  • maximum length 64
A Cantora Principal identifier, prefixed with `principal_`.
  • pattern ^principal_[\s\S]+$
grantIdrequired
stringThe identifier of the Grant issued with the identity.
All of
  • maximum length 64
A Cantora Grant identifier, prefixed with `grant_`.
  • pattern ^grant_[\s\S]+$
apiKeyIdrequired
stringThe identifier of the issued API key.
All of
  • maximum length 64
A Cantora API key identifier, prefixed with `apikey_`.
  • pattern ^apikey_[\s\S]+$
apiKeyrequired
stringThe provisioning credential, returned exactly once and never recoverable from Cantora
expiresAtrequired
stringWhen the issued API key expires, in UTC.
  • format date-time

UnauthorizedJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenJsonEncoding

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.