Portal settings

The settings of the workspace's portal: name, colors, sign-in, SSO, notifications and security headers. domain update sets the portal's address on the platform (and domain check-slug list says whether it is free), logo create / logo delete change the logo and favicon, and sender-identity create verifies the e-mail sender in AWS SES.

Command	HTTP	Description
`portal-settings list`	`GET /v1/portal_settings`	Get portal settings
`portal-settings update`	`PATCH /v1/portal_settings`	Update portal settings
`portal-settings domain update`	`PATCH /v1/portal_settings/domain`	Set portal address
`portal-settings domain check-slug list`	`GET /v1/portal_settings/domain/check_slug`	Check address availability
`portal-settings logo create`	`POST /v1/portal_settings/logo`	Upload portal image
`portal-settings logo delete`	`DELETE /v1/portal_settings/logo`	Delete portal image
`portal-settings sender-identity create`	`POST /v1/portal_settings/sender_identity`	Verify notification sender

Examples

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# Get portal settings
kobana dashboards portal-settings list \
  --fields "company_name,title,portal_slug,portal_domain"

# Update portal settings
kobana dashboards portal-settings update \
  --json '{"company_name": "Aurora", "title": "Portal do cliente"}'

# Check address availability
kobana dashboards portal-settings domain check-slug list \
  --params '{"slug": "aurora", "domain": "DOMINIO"}'

# Set portal address
kobana dashboards portal-settings domain update \
  --json '{"slug": "aurora", "domain": "DOMINIO"}'

Next steps

Custom domains
OIDC providers
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps