MB SuiteMB Suite
Menu

Referência da API · Cofre

Compartilhamentos

vault · shares · 2 operações

GET/v1/vault/sharesPOST/v1/vault/shares/{share_id}/revoke
GET/v1/vault/shares

List the vault's secure shared links

vault.shares.list

LeituraIdempotenteDesde 2026-11-01

Lists the secure links that share Vault credentials outside the team (Share access), newest first, paginated by cursor (limit up to 200), of the chosen scope: active (default; still open) or closed (revoked, used, blocked after 10 wrong keys, or expired). Each link: the credentials it includes (item_ids, item_titles), client account, status, expires_at, max_opens (1 = one time), opens, failed_attempts, last_opened_at, the recipient and note the creator wrote down, requires_key, who created it and when. Everyone with access to the Vault sees the team's links. It never returns the link itself, its code or its key: the URL is a bearer link and is only copied from the app. A link past its expiry is reported (and saved) as expired, and the page is completed reading up to 400 links. Requires view access to the Vault.

Escopo
vault:read
Permissão
Ver o módulo
Tool do MCP
vault_shares_listNa superfície completa; na compacta, mb_execute_operation com id: "vault.shares.list".

Custo declarado: até 501 leituras e 0 escritas por chamada (contam na cota diária).

Parâmetros

limitintegerqueryopcional

How many items this page brings at most (see the maximum and the default in the schema).

Padrão: 50

cursorstringqueryopcional

The next_cursor of the previous page, exactly as it came (only for the same list and filters); without it, the first page.

scopeenumqueryopcional

active (default) or closed (revoked, used, blocked or expired).

Valores: active, closed · Padrão: "active"

Resposta

dataarray<object>
has_moreboolean
next_cursorstring

Erros

invalid_inputunknown_fieldauthentication_requiredscope_insufficientmodule_access_deniedoperation_not_foundrate_limitedquota_exceeded

Exemplo

curl "https://api.mb-suite.com/v1/vault/shares" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl "https://api.mb-suite.com/v1/vault/shares" \
  -H "Authorization: Bearer $MB_TEST_KEY"
POST/v1/vault/shares/{share_id}/revoke

Revoke a secure shared link

vault.shares.revoke

EscritaIdempotenteDesde 2026-11-01

Closes a secure shared link at once: from now on it shows the neutral «not available» page and the credentials' «shared until» badge is recalculated. Only its creator, an owner or an admin can revoke it (vault_link_not_owner, 403). A revoked link cannot be reopened: create a new one in the app. Idempotent: on a link that is already closed (revoked, used, blocked or expired) nothing changes (changed=false). Returns the link. Requires edit access to the Vault.

Escopo
vault:write
Permissão
Editar no módulo
Tool do MCP
vault_shares_revokeNa superfície completa; na compacta, mb_execute_operation com id: "vault.shares.revoke".

Custo declarado: até 30 leituras e 21 escritas por chamada (contam na cota diária).

Parâmetros

share_idstringrotaobrigatório

The shared link's id (from vault.shares.list).

Resposta

shareobject
changedboolean

Erros

vault_share_not_foundinvalid_inputunknown_fieldauthentication_requiredscope_insufficientcrm_action_deniedidempotency_key_reusedrate_limitedquota_exceeded

Exemplo

curl -X POST "https://api.mb-suite.com/v1/vault/shares/{share_id}/revoke" \
  -H "Authorization: Bearer $MB_API_KEY"

Testar com a sua API key de teste

Com uma API key de teste o pedido vai sempre para a sua organização de prática: dados de exemplo que você pode reiniciar.

curl -X POST "https://api.mb-suite.com/v1/vault/shares/{share_id}/revoke" \
  -H "Authorization: Bearer $MB_TEST_KEY"