Saltar para o conteúdo principal

organization

Organização (config)

A coluna config de uma Organization. Quase tudo o que lá está é estado da própria organização (plano, faturação, segredos) e nunca sai num template - daí tanto opaque.

  • Kind: structure
  • Key: organization
  • Categoria: estrutura
  • Envelope: mapa (um objeto JSON em config)

Campos

ChaveTipoObrigatórioOmissãoDescriçãoReferência
variablesjsonnão-Variáveis da organização: mapa livre nome → valor.-
secretVariableslist de stringnão-Nomes das variáveis marcadas como secretas. Os VALORES vivem no variables: esta lista é só a marca. Opaco: transporta dados do utilizador e nenhum resolvedor entra aqui.-
colorenumerationnão-Cor nomeada da organização, escolhida no diálogo de gestão.-
defaultWorkspaceIduuidnão-Workspace a que a organização abre por omissão.workspace (uuid)
entitlementsmapnão-O plano subscrito e os seus limites, espelhados na organização. opaque: é estado de subscrição, escrito pelo servidor, nunca exportado. Opaco: transporta dados do utilizador e nenhum resolvedor entra aqui.-
billingmapnão-Estado de cobrança em falha (dunning), escrito pelo servidor. opaque: estado de faturação, nunca se exporta. Opaco: transporta dados do utilizador e nenhum resolvedor entra aqui.-

entitlements

ChaveTipoObrigatórioOmissãoDescriçãoReferência
planstringnão-Nome do tier (free, basic, pro, scale, enterprise).-
plan_labelstringnão-Nome do tier como se mostra ao utilizador.-
is_freebooleannão-Verdadeiro nos tiers sem pagamento.-
updated_atstringnão-Quando o espelho do tier foi escrito.-
featuresmapnão-O bloco features do plano, copiado em cheio do catálogo de planos.-

entitlements.features

ChaveTipoObrigatórioOmissãoDescriçãoReferência
supportstringnão-Nível de suporte do tier (community, email, priority, dedicated).-
limitsmapnão-Tetos do plano; null = ilimitado.-
capabilitiesmapnão-O que o plano deixa fazer; o cliente lê por capability(nome) e o servidor impõe à parte.-

entitlements.features.limits

ChaveTipoObrigatórioOmissãoDescriçãoReferência
workspacesintegernão-Máximo de workspaces da organização.-
records_per_workspaceintegernão-Máximo de linhas por workspace.-
storage_gbintegernão-Armazenamento incluído, em GB.-
kiosk_terminalsintegernão-Máximo de terminais de quiosque; o catálogo de planos ainda não o preenche.-

entitlements.features.capabilities

ChaveTipoObrigatórioOmissãoDescriçãoReferência
build_from_scratchbooleannão-Capacidade build_from_scratch do plano.-
manual_workflowsbooleannão-Capacidade manual_workflows do plano.-
automationsbooleannão-Capacidade automations do plano.-
ai_chatbooleannão-Capacidade ai_chat do plano.-
ai_fullbooleannão-Capacidade ai_full do plano.-
advanced_viewsbooleannão-Capacidade advanced_views do plano.-
apibooleannão-Capacidade api do plano.-
portalsbooleannão-Capacidade portals do plano.-
white_labelbooleannão-Capacidade white_label do plano.-
fine_permissionsbooleannão-Capacidade fine_permissions do plano.-
reusable_templatesbooleannão-Capacidade reusable_templates do plano.-
ssobooleannão-Capacidade sso do plano.-
byokbooleannão-Capacidade byok do plano.-
slabooleannão-Capacidade sla do plano.-

billing

ChaveTipoObrigatórioOmissãoDescriçãoReferência
past_duebooleannão-Verdadeiro enquanto houver pagamento falhado em retentativa; é o que faz aparecer o aviso de cobrança no cliente. O acesso mantém-se.-
sincestringnão-Instante em que a falha foi registada.-

Exemplo JSON

{}

Gerado de definitions.json versão 17f3e0bc59d9. Esta página nasce no build: não se edita à mão.