Skip to content
CantoraAPI documentation
POST
/v1/organizations

Create an Organization

Create an empty customer Organization during Cantora-operated provisioning.

Authentication

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

Parameters

This operation has no path or query parameters.

Request body

Required.

application/json
object
  • unknown properties allowed false
namerequired
stringThe customer-facing Organization name.
  • maximum length 200
  • minimum length 1

Responses

201OrganizationCreated
application/json
OrganizationCreatedJsonEncoding
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedJsonEncoding
403Forbidden
application/json
ForbiddenJsonEncoding

Reusable schemas

OrganizationCreatedJsonEncoding

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]+$
namerequired
stringThe human-readable resource name.
createdAtrequired
stringWhen the resource was created, 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.