Saltar al contenido principal

Portal

El sitio del portal — borrador, publicación y versiones de las páginas, y la biblioteca de archivos que muestra — y su configuración: marca, dominio, dominios propios y proveedores de inicio de sesión.

Familias en esta página​

FamiliaToolsreadwritedestructive
portal-builder — Constructor del portal9234
assets — Archivos7331
portal-settings — Configuración del portal7232
portal-custom-domains — Dominios propios5212
portal-oauth-providers — Proveedores de inicio de sesión5122

portal-builder​

ToolTipoPermisoEndpointQué hace
dashboards_portal_builder_getreadportal-config.viewGET /v1/portal_builderRead the portal builder of the workspace: portal identity, the draft (pages with their badge against the live version, revision, dirty), the live version number, the published versions, the theme and the SEO defaults.
dashboards_portal_builder_draft_savewriteportal-config.updatePUT /v1/portal_builder/draftSave the whole portal draft (pages in menu order, editor state, optional theme and SEO defaults), guarded by revision.
dashboards_portal_builder_publishdestructiveportal-config.updatePOST /v1/portal_builder/publishSave the draft as sent and publish it as the next portal version — visitors see it immediately.
dashboards_portal_builder_versions_getreadportal-config.viewGET /v1/portal_builder/versions/:numberFetch one published portal version by number, with the pages it froze.
dashboards_portal_builder_versions_rollbackdestructiveportal-config.updatePOST /v1/portal_builder/versions/:number/rollbackPut a published version back on the air as the next version number — visitors see it immediately.
dashboards_portal_builder_seal_secretwriteportal-config.updatePOST /v1/portal_builder/secretsEncrypt a value a block keeps in the page JSON (e.g.
dashboards_portal_builder_og_image_uploadwriteportal-config.updatePOST /v1/portal_builder/og_imageUpload an og:image (PNG, JPEG or WebP, base64, at most ~1.5 MB) for a page or the portal defaults.
dashboards_portal_builder_form_submissions_createdestructiveportal-config.updatePOST /v1/portal_builder/form_submissionsTest a form block from your draft: really sends the configured e-mail (or fires the chosen webhook), marked as a preview.
dashboards_portal_builder_action_runs_createdestructiveportal-config.updatePOST /v1/portal_builder/action_runsTest an action-button block from your draft: really sends its webhook request (POST/PUT/PATCH to an https URL), marked as a preview.

assets​

ToolTipoPermisoEndpointQué hace
dashboards_assets_listreadportal-config.viewGET /v1/assetsList the files of the workspace library (images and documents), newest first by default.
dashboards_assets_getreadportal-config.viewGET /v1/assets/:idFetch one file of the library: name, link, visibility, type, size and alternative text.
dashboards_assets_downloadreadportal-config.viewGET /v1/assets/:id/downloadGet the bytes of a file, whatever its visibility.
dashboards_assets_presignwriteportal-config.updatePOST /v1/assets/presignGet a short-lived signed URL to PUT a file straight to storage (for files over ~1.5 MB).
dashboards_assets_createwriteportal-config.updatePOST /v1/assetsAdd a file to the library: either the key of a file sent through dashboards_assets_presign, or the file itself in content_base64 (small files).
dashboards_assets_updatewriteportal-config.updatePATCH /v1/assets/:idRename a file, change its alternative text or its visibility (making it public opens its storage URL to anyone; private or restricted closes it).
dashboards_assets_deletedestructiveportal-config.updateDELETE /v1/assets/:idRemove a file from the library.

portal-settings​

ToolTipoPermisoEndpointQué hace
dashboards_portal_settings_getreadportal-config.viewGET /v1/portal_settingsRead the workspace portal's configuration: branding (company name, title, logos, theme colors), languages, address (signup_slug, portal_slug/portal_domain), login and SSO options, notification settings and sender identity, and site settings (security headers, SEO, tracking/chat integrations, custom code).
dashboards_portal_settings_updatewriteportal-config.updatePATCH /v1/portal_settingsUpdate the workspace portal's configuration.
dashboards_portal_settings_logo_uploadwriteportal-config.updatePOST /v1/portal_settings/logoUpload a portal image — the logo, the dark-background logo or the favicon — sent inline as base64.
dashboards_portal_settings_logo_deletedestructiveportal-config.updateDELETE /v1/portal_settings/logoRemove a portal image (logo, dark-background logo or favicon); the portal falls back to its default.
dashboards_portal_settings_domain_updatewriteportal-config.updatePATCH /v1/portal_settings/domainSet the portal's platform address https://{slug}.{domain} (domain must be one of available_domains from dashboards_portal_settings_get), or clear it with both null.
dashboards_portal_settings_check_slugreadportal-config.viewGET /v1/portal_settings/domain/check_slugCheck whether a portal address slug.domain is free for this workspace.
dashboards_portal_settings_verify_sender_identitydestructiveportal-config.updatePOST /v1/portal_settings/sender_identityRequest or re-check the AWS SES verification of the notification sender e-mail.

portal-custom-domains​

ToolTipoPermisoEndpointQué hace
dashboards_portal_custom_domains_listreadportal-config.viewGET /v1/portal_custom_domainsList the custom domains of the workspace's portal, each with its status, certificate dates and the dns_records the customer must publish.
dashboards_portal_custom_domains_createwriteportal-config.updatePOST /v1/portal_custom_domainsRegister a custom domain (e.g.
dashboards_portal_custom_domains_deletedestructiveportal-config.updateDELETE /v1/portal_custom_domains/:idRemove a custom domain from the portal, tearing down its CloudFront tenant and certificate when provisioned.
dashboards_portal_custom_domains_verifydestructiveportal-config.updatePOST /v1/portal_custom_domains/:id/verifyCheck the DNS of a custom domain and provision it on AWS (certificate + CloudFront tenant) while pending, or refresh its status once provisioned.
dashboards_portal_custom_domains_dns_statusreadportal-config.viewGET /v1/portal_custom_domains/:id/dns_statusRead-only DNS probe of a custom domain: whether the ownership TXT (_dashmagico-verify.{hostname}, ownership_ok) and the routing and certificate-validation CNAMEs (routing_ok, validation_ok) are in place, and what is wrong when not.

portal-oauth-providers​

ToolTipoPermisoEndpointQué hace
dashboards_portal_oauth_providers_listreadportal-config.viewGET /v1/portal_oauth_providersList the portal's OpenID Connect login providers (name, issuer, client id, scopes, enabled).
dashboards_portal_oauth_providers_createwriteportal-config.updatePOST /v1/portal_oauth_providersAdd an OpenID Connect login provider to the portal.
dashboards_portal_oauth_providers_updatewriteportal-config.updatePATCH /v1/portal_oauth_providers/:idUpdate an OpenID Connect login provider.
dashboards_portal_oauth_providers_deletedestructiveportal-config.updateDELETE /v1/portal_oauth_providers/:idRemove an OpenID Connect login provider from the portal; its login button disappears and its users can no longer sign in through it.
dashboards_portal_oauth_providers_testdestructiveportal-config.updatePOST /v1/portal_oauth_providers/testPre-flight check of an OIDC issuer URL: fetches its discovery document from the third-party issuer and returns its endpoints (ok: true) or why it failed (ok: false).

Los campos de cada recurso están en la Referencia de la API y en dashboards_schemas_get.

Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.