Pular para o conteúdo principal

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íliaToolsreadwritedestructive
portal-users — Usuários do portal13625
checklists — Checklists (progresso por tenant)8422
comments — Comentários (conversa por tenant)4211
users — Usuários do dashboard10424
roles — Papéis do time6231

portal-users​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_portal_users_listreadreadportal-users.listGET /v1/portal_usersList the portal users of the workspace.
dashboards_portal_users_getreadreadportal-users.showGET /v1/portal_users/:idFetch one portal user by id or external_id.
dashboards_portal_users_createdestructivewriteportal-users.createPOST /v1/portal_usersCreate a portal user in the workspace as pending_invitation and send the invitation e-mail.
dashboards_portal_users_invitedestructivewriteportal-users.createPOST /v1/portal_users/inviteInvite 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_updatewrite · confirmação (conforme os argumentos)writeportal-users.updatePATCH /v1/portal_users/:idUpdate 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_deletedestructivedeleteportal-users.deleteDELETE /v1/portal_users/:idDelete 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_invitedestructivewriteportal-users.updatePOST /v1/portal_users/:id/resendRe-send the invitation e-mail (pending invitation, rotating the link) or the verification e-mail (pending verification).
dashboards_portal_users_email_previewreadreadportal-users.showGET /v1/portal_users/:id/email-previewRender 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_activityreadreadportal-users.showGET /v1/portal_users/:id/activityUsage 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_timelinereadreadportal-users.showGET /v1/portal_users/:id/activity/timelineWhat 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_getreadreadportal-users.listGET /v1/portal_user_mappingsShow 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_updatewrite · confirmaçãowriteportal-users.createPUT /v1/portal_user_mappingsMap 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_deletedestructivedeleteportal-users.createDELETE /v1/portal_user_mappingsStop syncing portal users from the mapped entity.

checklists​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_checklists_listreadreadportal-users.listGET /v1/checklistsList 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_getreadreadportal-users.showGET /v1/checklists/:idFetch one checklist of the published portal: its stages and visible tasks.
dashboards_checklists_progress_getreadreadportal-users.showGET /v1/checklists/:id/progressA 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_updatewritewriteportal-users.updatePUT /v1/checklists/:id/progressSet the status of one or more tasks of a checklist for a tenant (creates the tenant's progress on first use).
dashboards_checklists_progress_resetdestructivedeleteportal-users.updateDELETE /v1/checklists/:id/progressReset 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_downloadreadreadportal-users.showGET /v1/checklists/:id/progress/fileGet the file a tenant sent to a Solicitação task of a checklist.
dashboards_checklists_file_uploadwrite · confirmaçãowriteportal-users.updatePOST /v1/checklists/:id/progress/fileSend the file of a Solicitação task for a tenant (in content_base64), replacing the one sent before.
dashboards_checklists_file_deletedestructivedeleteportal-users.updateDELETE /v1/checklists/:id/progress/fileTake back the file a tenant sent to a Solicitação task of a checklist.

comments​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_comments_listreadreadportal-users.showGET /v1/commentsList 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_getreadreadportal-users.showGET /v1/comments/:idFetch one comment: its tenant, author, body and whether it is internal.
dashboards_comments_createwrite · confirmação (conforme os argumentos)writeportal-users.updatePOST /v1/commentsAdd a comment to a tenant's conversation, as the team.
dashboards_comments_deletedestructivedeleteportal-users.updateDELETE /v1/comments/:idRemove a comment from its conversation (soft delete): it leaves the portal and the dashboard for everyone.

users​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_dashboard_users_listreadreadusers.listGET /v1/dashboard_usersList the dashboard (team) users of the organization.
dashboards_dashboard_users_getreadreadusers.showGET /v1/dashboard_users/:idFetch one dashboard user with the roles they hold.
dashboards_dashboard_users_createdestructivewriteusers.createPOST /v1/dashboard_usersAdd a dashboard user to the organization and assign a role.
dashboards_dashboard_users_upsertdestructivewriteusers.createPUT /v1/dashboard_usersCreate or update a dashboard user matched on id → external_id → email.
dashboards_dashboard_users_updatewrite · confirmação (conforme os argumentos)writeusers.updatePATCH /v1/dashboard_users/:idUpdate a dashboard user — name, role or status.
dashboards_dashboard_users_deletedestructivedeleteusers.deleteDELETE /v1/dashboard_users/:idRemove a dashboard user.
dashboards_dashboard_users_workspaces_getreadreadusers.grantGET /v1/dashboard_users/:id/workspacesList 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_setwrite · confirmaçãowriteusers.grantPUT /v1/dashboard_users/:id/workspacesReplace the set of workspaces a team member can open: workspace_ids is the final set, removed grants are paused.
dashboards_dashboard_users_resend_invitedestructivewriteusers.createPOST /v1/dashboard_users/:id/resendRe-send the invitation e-mail, with a fresh sign-in link, to a team member whose invitation is still pending.
dashboards_permissions_listreadreadusers.permissionsGET /v1/permissionsList the dashboard permissions a team member or role can carry, grouped by resource, with a label and description for each key.

roles​

ToolTipoEscopoPermissãoEndpointO que faz
dashboards_team_roles_listreadreadroles.listGET /v1/team_rolesList the roles a dashboard user can hold, with their permission sets.
dashboards_team_roles_getreadreadroles.showGET /v1/team_roles/:idFetch one role with its permissions.
dashboards_team_roles_createwrite · confirmaçãowriteroles.createPOST /v1/team_rolesCreate a custom role with an explicit permission list.
dashboards_team_roles_upsertwrite · confirmaçãowriteroles.createPUT /v1/team_rolesCreate or update a role matched on id → external_id → slug.
dashboards_team_roles_updatewrite · confirmaçãowriteroles.updatePATCH /v1/team_roles/:idUpdate a custom role.
dashboards_team_roles_deletedestructivedeleteroles.deleteDELETE /v1/team_roles/:idDelete 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.