Pular para o conteúdo principal

Configurações do portal

As configurações do portal do workspace: nome, cores, login, SSO, notificações e cabeçalhos de segurança. domain update define o endereço do portal na plataforma (e domain check-slug list diz se ele está livre), logo create / logo delete trocam o logo e o favicon, e sender-identity create verifica o remetente dos e-mails no AWS SES.

ComandoHTTPDescrição
portal-settings listGET /v1/portal_settingsObter configurações do portal
portal-settings updatePATCH /v1/portal_settingsAtualizar configurações do portal
portal-settings domain updatePATCH /v1/portal_settings/domainDefinir endereço do portal
portal-settings domain check-slug listGET /v1/portal_settings/domain/check_slugVerificar disponibilidade do endereço
portal-settings logo createPOST /v1/portal_settings/logoEnviar imagem do portal
portal-settings logo deleteDELETE /v1/portal_settings/logoRemover imagem do portal
portal-settings sender-identity createPOST /v1/portal_settings/sender_identityVerificar remetente das notificações

Exemplos​

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Obter configurações do portal
kobana dashboards portal-settings list \
--fields "company_name,title,portal_slug,portal_domain"

# Atualizar configurações do portal
kobana dashboards portal-settings update \
--json '{"company_name": "Aurora", "title": "Portal do cliente"}'

# Verificar disponibilidade do endereço
kobana dashboards portal-settings domain check-slug list \
--params '{"slug": "aurora", "domain": "DOMINIO"}'

# Definir endereço do portal
kobana dashboards portal-settings domain update \
--json '{"slug": "aurora", "domain": "DOMINIO"}'

Próximos passos​