Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Master passwords

Create, list, rename, and delete scoped master passwords. Master passwords are additional SMTP mailbox login passwords that can apply to every mailbox in an account, workspace, or domain scope. They are separate from Hybridbox user login passwords and are not used for encryption. The examples use A2A code mode. MCP exposes the same code mode through its execute tool.

​
Functions

​
credentials.add

credentials.add(account_id: str, name: str, domain?: str | null, generate?: bool, value?: str | null, workspace_id?: str | null) -> MasterPassword
Create master passwords.
PropertyValuePropertyValue
Requires permissioncredential.manageAuth requiredyes
Execution modesyncCapabilitycredential.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/credentials
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
namestryesMaster password display name
domainstr | nullnoDomain UUID or domain name scope for the master password
generateboolnoGenerate a master password secret instead of supplying one
valuestr | nullnoMaster password secret value when not generated
workspace_idstr | nullnoWorkspace UUID scope for the master password
FieldTypeRequiredDescription
created_atstryesMaster password creation timestamp
idstryesMaster password UUID
namestryesMaster password display name
scope_idstryesResource UUID for the master password scope
scope_type"account" | "workspace" | "domain"yesResource scope type where the master password applies
updated_atstryesMaster password last update timestamp
generated_secretstr | nullnoOne-time generated master password secret, when requested
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "credentials.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\", domain=\"example.com\", generate=true, value=\"<string>\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "credentials.add",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "credentials.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\", domain=\"example.com\", generate=true, value=\"<string>\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"credentials.add\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
credentials.delete

credentials.delete(account_id: str, credential_id: str) -> {}
Delete master passwords.
PropertyValuePropertyValue
Requires permissioncredential.manageAuth requiredyes
Execution modesyncCapabilitycredential.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/credentials/{credential_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
credential_idstryesMaster password UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "credentials.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", credential_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "credentials.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "credentials.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", credential_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"credentials.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
credentials.list

credentials.list(account_id: str, page?: int, page_size?: int) -> Page[MasterPassword]
List master passwords.
PropertyValuePropertyValue
Requires permissioncredential.viewAuth requiredyes
Execution modesyncCapabilitycredential.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/credentials
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
pageintnoOne-based master password page number
page_sizeintnoMaximum master passwords per page
FieldTypeRequiredDescription
items[{"created_at": str, "id": str, "name": str, "scope_id": str, "scope_type": "account" | "workspace" | "domain", "updated_at": str}]yesMaster passwords on this page
pageintyesCurrent one-based page number
page_sizeintyesMaximum items per page
totalintyesTotal matching master passwords
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "credentials.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "credentials.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "credentials.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"credentials.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
credentials.update

credentials.update(account_id: str, credential_id: str, name: str) -> MasterPassword
Update master passwords.
PropertyValuePropertyValue
Requires permissioncredential.manageAuth requiredyes
Execution modesyncCapabilitycredential.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/credentials/{credential_id}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
credential_idstryesMaster password UUID from the route path
namestryesMaster password display name
FieldTypeRequiredDescription
created_atstryesMaster password creation timestamp
idstryesMaster password UUID
namestryesMaster password display name
scope_idstryesResource UUID for the master password scope
scope_type"account" | "workspace" | "domain"yesResource scope type where the master password applies
updated_atstryesMaster password last update timestamp
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "credentials.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", credential_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "credentials.update",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "credentials.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", credential_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"credentials.update\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}