Skip to content
CantoraAPI documentation
POST
/v1/organizations/{organizationId}/projects/{projectId}/environments/{environmentId}/surface-registrations/{surfaceRegistrationId}/tenants/{tenantId}/connections

Connect one Tenant workspace to a registered Surface

Install a Tenant-scoped provider Connection beneath an Environment Surface registration; the bot credential is write-only.

Authentication

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

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
stringA Cantora Organization identifier, prefixed with `org_`.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdpathYes
The Project to address.
stringA Cantora Project identifier, prefixed with `proj_`.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdpathYes
The Environment to address.
stringA Cantora Environment identifier, prefixed with `env_`.
  • maximum length 64
  • pattern ^env_[\s\S]+$
surfaceRegistrationIdpathYes
The Environment Surface registration to address.
stringA Cantora Surface registration identifier, prefixed with `surface_`.
  • maximum length 64
  • pattern ^surface_[\s\S]+$
tenantIdpathYes
The Tenant to address.
stringA Cantora Tenant identifier, prefixed with `tenant_`.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$

Request body

Required.

application/json
object
  • unknown properties allowed false
providerrequired
stringThe Surface provider this Connection authorizes.
  • allowed values "slack"
providerIssuerrequired
stringThe provider account or workspace in which this Connection is installed.
  • maximum length 512
  • minimum length 1
  • pattern ^[!-~]+$
botTokenrequired
stringThe write-only provider bot credential used to deliver messages.
  • maximum length 8192
  • minimum length 1
  • write only true

Responses

201ConnectionCreated
application/json
ConnectionCreatedEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded
404NotFound
application/json
NotFoundEncoded
409Conflict
application/json
ConflictEncoded

Reusable schemas

ConnectionCreatedEncoded

object
  • unknown properties allowed false
connectionIdrequired
stringThe installed provider Connection identifier.
  • maximum length 64
  • pattern ^connection_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
projectIdrequired
stringThe Project identifier.
  • maximum length 64
  • pattern ^proj_[\s\S]+$
environmentIdrequired
stringThe Environment identifier.
  • maximum length 64
  • pattern ^env_[\s\S]+$
tenantIdrequired
stringThe Tenant identifier.
  • maximum length 64
  • pattern ^tenant_[\s\S]+$
surfaceRegistrationIdrequired
stringThe Environment Surface registration identifier.
  • maximum length 64
  • pattern ^surface_[\s\S]+$
providerrequired
stringThe model, Surface, or integration provider key.
  • allowed values "slack"
providerIssuerrequired
stringThe provider account or workspace boundary.
  • maximum length 512
  • minimum length 1
  • pattern ^[!-~]+$
credentialGenerationrequired
integerThe current credential generation, incremented on rotation.
  • greater than 0
etagrequired
stringThe strong ETag required for the next conditional mutation.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$
statusrequired
ConnectionStatusThe current lifecycle status.
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

UnauthorizedEncoded

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.

ForbiddenEncoded

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

NotFoundEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "NotFound"
resourcerequired
stringThe resource type relevant to the error.
idrequired
stringThe identifier supplied for the resource that was not found.

ConflictEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Conflict"
resourcerequired
stringThe resource type relevant to the error.
reasonrequired
stringA safe explanation of the state conflict.

ConnectionStatus

string
  • allowed values "active", "disabled", "reauthorizationRequired"