API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · tenant_links

Tenant Link Schema

Schema-ID
tenant_link
Collection
tenant_links
Permissions
  • Lesentenant_link_view
  • Anlegentenant_link_manage
  • Änderntenant_link_manage
  • Löschentenant_link_manage

Felder

Tenant Link Schema

tenant_links4 Permissions

Consent-based federation link between two Codemeta tenants, possibly on different installations (ADR 0445)

labelstringoptional

Display name for the connection list. Never sent over the wire.

max 120 Zeichennullable
peerKindstringerforderlich

local = another tenant of this installation (loopback, no secrets); remote = a foreign installation (signed HTTPS).

localremote
read-only
baseUrlstringoptional

Remote only. HTTPS enforced and re-validated against assertSafeOutgoingUrl before every call (SSRF).

max 500 Zeichennullable
peerInstallationIdstringoptional

Opaque id of the counterpart installation, stamped during the handshake.

max 200 Zeichenread-onlynullable
peerTenantIdstringoptional

Counterpart tenant. Stamped on redemption only — never client-writable.

read-onlynullable
invitationCodestringoptional

Server-generated invitation. Unique while pending, cleared on redemption. Redacted from every read.

read-onlynullable
invitationExpiresAtdatetimeoptional

After this instant the code no longer redeems.

read-onlynullable
statusstringerforderlich
pendingacceptedrevoked
Default: "pending"read-only
revokedSidestringoptional

Which side ended it. Both sides may revoke.

initiatorpeer
read-onlynullable
rolesobjectoptional
nullable
mspTenantIdstringoptional
nullable
customerTenantIdstringoptional
nullable
partyIduuidoptional

THE anchor — the customer party in the MSP CRM. Never leaves the installation.

nullable
protocolVersionintegeroptional

Negotiated major version, min(local, peer).

≥ 1Default: 1read-only
capabilitiesobjectoptional

What the PEER may do here. Server-enforced.

read-only
createTicketbooleanoptional
Default: false
commentbooleanoptional
Default: true
changeStatusbooleanoptional
Default: true
changePrioritybooleanoptional
Default: true
requestReturnbooleanoptional
Default: true
peerCapabilitiesobjectoptional

What we may do there. Display / pre-flight only — never an authorisation basis.

read-onlynullable
createTicketbooleanoptional
commentbooleanoptional
changeStatusbooleanoptional
changePrioritybooleanoptional
requestReturnbooleanoptional
inboundKeyIdstringoptional

NON-SECRET selector (X-Codemeta-Peer-Key). Installation-wide unique — the ingress knows no tenant yet.

read-onlynullable
inboundSecretEncobjectoptional

AES-256-GCM blob of the secret inbound signatures are verified with. Encrypted, NOT hashed — HMAC verification needs the plaintext.

read-onlynullable
__encryptedbooleanoptional
ivstringoptional
tagstringoptional
ciphertextstringoptional
inboundSecretRotatedAtdatetimeoptional
read-onlynullable
outboundKeyIdstringoptional

The counterpart's selector — what we send in X-Codemeta-Peer-Key.

read-onlynullable
outboundSecretEncobjectoptional

AES-256-GCM blob of the secret outbound signatures are created with.

read-onlynullable
__encryptedbooleanoptional
ivstringoptional
tagstringoptional
ciphertextstringoptional
outboundSecretRotatedAtdatetimeoptional
read-onlynullable
exchangeobjectoptional

TicketExchangeConfig (ADR 0363 §1b) — target, statusMap, priorityMap. Same type as the Jira side.

nullable
acceptedAtdatetimeoptional
read-onlynullable
acceptedBystringoptional
read-onlynullable
revokedAtdatetimeoptional
read-onlynullable
revokedBystringoptional
read-onlynullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/tenant_links — Liste, paginiert + filterbar
  • GET /api/v1/tenant_links/<id> — Einzelne Entity
  • POST /api/v1/tenant_links — Anlegen
  • PATCH /api/v1/tenant_links/<id> — Teil-Update
  • DELETE /api/v1/tenant_links/<id> — Soft-Delete
  • GET /api/v1/tenant_links/<id>/timeline — Audit + Aktivitäten

Suche