Acessos
Os usuários que entram no portal — cada um com o ID do titular dos registros que vê — e o time que usa o dashboard da organização.
Famílias nesta página
| Família | Tools | read | write | destructive |
|---|---|---|---|---|
portal-users — Usuários do portal | 13 | 6 | 2 | 5 |
checklists — Checklists (progresso por tenant) | 8 | 4 | 2 | 2 |
comments — Comentários (conversa por tenant) | 4 | 2 | 1 | 1 |
users — Usuários do dashboard | 10 | 4 | 2 | 4 |
roles — Papéis do time | 6 | 2 | 3 | 1 |
portal-users
| Tool | Tipo | Escopo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|---|
dashboards_portal_users_list | read | read | portal-users.list | GET /v1/portal_users | List the portal users of the workspace. |
dashboards_portal_users_get | read | read | portal-users.show | GET /v1/portal_users/:id | Fetch one portal user by id or external_id. |
dashboards_portal_users_create | destructive | write | portal-users.create | POST /v1/portal_users | Create a portal user in the workspace as pending_invitation and send the invitation e-mail. |
dashboards_portal_users_invite | destructive | write | portal-users.create | POST /v1/portal_users/invite | Invite a portal user — same as dashboards_portal_users_create, through the verb route: creates the user and sends the invitation e-mail. |
dashboards_portal_users_update | write · confirmação (conforme os argumentos) | write | portal-users.update | PATCH /v1/portal_users/:id | Update a portal user — e-mail, tenant_id, external_id, sso_only, custom_metadata, status (active ↔ suspended only), or unlock: true to end a login lockout (too many wrong passwords). |
dashboards_portal_users_delete | destructive | delete | portal-users.delete | DELETE /v1/portal_users/:id | Delete a portal user: a pending invitation is deleted, anyone else is suspended and loses portal access immediately; an already suspended user is left unchanged. |
dashboards_portal_users_resend_invite | destructive | write | portal-users.update | POST /v1/portal_users/:id/resend | Re-send the invitation e-mail (pending invitation, rotating the link) or the verification e-mail (pending verification). |
dashboards_portal_users_email_preview | read | read | portal-users.show | GET /v1/portal_users/:id/email-preview | Render the invitation or verification e-mail of a pending portal user without sending it — subject and message, as the recipient would see it. |
dashboards_portal_users_activity | read | read | portal-users.show | GET /v1/portal_users/:id/activity | Usage analytics of one portal user: sign-ins and pages viewed (all time), distinct pages, last_activity_at, a per-day series of views and sign-ins over the last days days (São Paulo days) and the most opened pages (top_pages). |
dashboards_portal_users_activity_timeline | read | read | portal-users.show | GET /v1/portal_users/:id/activity/timeline | What a portal user did, newest first: sign-ins (kind: login, with the sign-in method: credentials, magic-link or sso) and pages opened (kind: page_view, with path and page_name). |
dashboards_portal_user_mappings_get | read | read | portal-users.list | GET /v1/portal_user_mappings | Show which entity feeds the workspace portal users (mapping, null when none, with the last sync outcome) and the entities that could, with their fields. |
dashboards_portal_user_mappings_update | write · confirmação | write | portal-users.create | PUT /v1/portal_user_mappings | Map an entity to the workspace portal users — one user per e-mail of its records, tenant ID from a field — and sync now. |
dashboards_portal_user_mappings_delete | destructive | delete | portal-users.create | DELETE /v1/portal_user_mappings | Stop syncing portal users from the mapped entity. |
checklists
| Tool | Tipo | Escopo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|---|
dashboards_checklists_list | read | read | portal-users.list | GET /v1/checklists | List the checklists (Lista de Tarefas blocks) of the published portal, page by page: id, title, page and the stages with their visible tasks (title, description, due date, assignee, action). |
dashboards_checklists_get | read | read | portal-users.show | GET /v1/checklists/:id | Fetch one checklist of the published portal: its stages and visible tasks. |
dashboards_checklists_progress_get | read | read | portal-users.show | GET /v1/checklists/:id/progress | A tenant's progress on a checklist, task by task: status (pending, in_progress, done), when it was done, the file sent to a Solicitação, which portal user changed it last; plus done/total per stage and overall. |
dashboards_checklists_progress_update | write | write | portal-users.update | PUT /v1/checklists/:id/progress | Set the status of one or more tasks of a checklist for a tenant (creates the tenant's progress on first use). |
dashboards_checklists_progress_reset | destructive | delete | portal-users.update | DELETE /v1/checklists/:id/progress | Reset a tenant's progress on a checklist: the tasks of task_ids (all of them when omitted) go back to pending and forget the file sent. |
dashboards_checklists_file_download | read | read | portal-users.show | GET /v1/checklists/:id/progress/file | Get the file a tenant sent to a Solicitação task of a checklist. |
dashboards_checklists_file_upload | write · confirmação | write | portal-users.update | POST /v1/checklists/:id/progress/file | Send the file of a Solicitação task for a tenant (in content_base64), replacing the one sent before. |
dashboards_checklists_file_delete | destructive | delete | portal-users.update | DELETE /v1/checklists/:id/progress/file | Take back the file a tenant sent to a Solicitação task of a checklist. |
comments
| Tool | Tipo | Escopo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|---|
dashboards_comments_list | read | read | portal-users.show | GET /v1/comments | List comments, newest first, page by page: one tenant's conversation (tenant_id or portal_user_id) or, without either, every conversation of the workspace. |
dashboards_comments_get | read | read | portal-users.show | GET /v1/comments/:id | Fetch one comment: its tenant, author, body and whether it is internal. |
dashboards_comments_create | write · confirmação (conforme os argumentos) | write | portal-users.update | POST /v1/comments | Add a comment to a tenant's conversation, as the team. |
dashboards_comments_delete | destructive | delete | portal-users.update | DELETE /v1/comments/:id | Remove a comment from its conversation (soft delete): it leaves the portal and the dashboard for everyone. |
users
| Tool | Tipo | Escopo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|---|
dashboards_dashboard_users_list | read | read | users.list | GET /v1/dashboard_users | List the dashboard (team) users of the organization. |
dashboards_dashboard_users_get | read | read | users.show | GET /v1/dashboard_users/:id | Fetch one dashboard user with the roles they hold. |
dashboards_dashboard_users_create | destructive | write | users.create | POST /v1/dashboard_users | Add a dashboard user to the organization and assign a role. |
dashboards_dashboard_users_upsert | destructive | write | users.create | PUT /v1/dashboard_users | Create or update a dashboard user matched on id → external_id → email. |
dashboards_dashboard_users_update | write · confirmação (conforme os argumentos) | write | users.update | PATCH /v1/dashboard_users/:id | Update a dashboard user — name, role or status. |
dashboards_dashboard_users_delete | destructive | delete | users.delete | DELETE /v1/dashboard_users/:id | Remove a dashboard user. |
dashboards_dashboard_users_workspaces_get | read | read | users.grant | GET /v1/dashboard_users/:id/workspaces | List every workspace of the organization flagged with whether a team member holds a grant on it (granted) and their role there. |
dashboards_dashboard_users_workspaces_set | write · confirmação | write | users.grant | PUT /v1/dashboard_users/:id/workspaces | Replace the set of workspaces a team member can open: workspace_ids is the final set, removed grants are paused. |
dashboards_dashboard_users_resend_invite | destructive | write | users.create | POST /v1/dashboard_users/:id/resend | Re-send the invitation e-mail, with a fresh sign-in link, to a team member whose invitation is still pending. |
dashboards_permissions_list | read | read | users.permissions | GET /v1/permissions | List the dashboard permissions a team member or role can carry, grouped by resource, with a label and description for each key. |
roles
| Tool | Tipo | Escopo | Permissão | Endpoint | O que faz |
|---|---|---|---|---|---|
dashboards_team_roles_list | read | read | roles.list | GET /v1/team_roles | List the roles a dashboard user can hold, with their permission sets. |
dashboards_team_roles_get | read | read | roles.show | GET /v1/team_roles/:id | Fetch one role with its permissions. |
dashboards_team_roles_create | write · confirmação | write | roles.create | POST /v1/team_roles | Create a custom role with an explicit permission list. |
dashboards_team_roles_upsert | write · confirmação | write | roles.create | PUT /v1/team_roles | Create or update a role matched on id → external_id → slug. |
dashboards_team_roles_update | write · confirmação | write | roles.update | PATCH /v1/team_roles/:id | Update a custom role. |
dashboards_team_roles_delete | destructive | delete | roles.delete | DELETE /v1/team_roles/:id | Delete a custom role. |
Os campos de cada recurso estão na Referência da API e em dashboards_schemas_get.
Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.