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.

Auth

Authenticate, end, and inspect the runtime session. The examples use A2A code mode. MCP exposes the same code mode through its execute tool.

Functions

auth.authorizations.grant

auth.authorizations.grant(account_id: str, grant_kind: "capability" | "account_owner" | "super_admin", subject_id: str, subject_type: "user" | "group" | "service_account", capability_key?: str | null, resource_id?: str | null, resource_type?: "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null) -> Session
Grant account authorizations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/authorizations
NameTypeRequiredDescription
account_idstryesAccount UUID
grant_kind"capability" | "account_owner" | "super_admin"yesGrant kind
subject_idstryesUser or group identifier
subject_type"user" | "group" | "service_account"yesSubject type: user or group
capability_keystr | nullnoCapability key for capability grants
resource_idstr | nullnoScoped resource identifier
resource_type"client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | nullnoScoped resource type
FieldTypeRequiredDescription
grant_kindstryes
idstryes
subject_idstryes
subject_typestryes
capability_keystr | nullno
created_atstr | nullno
resource_idstr | nullno
resource_typestr | nullno
revoked_atstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.authorizations.grant(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", grant_kind=\"<string>\", subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<string>\", capability_key=\"<string>\", resource_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", resource_type=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.authorizations.grant",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.authorizations.grant(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", grant_kind=\"<string>\", subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<string>\", capability_key=\"<string>\", resource_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", resource_type=\"<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\": \"auth.authorizations.grant\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.authorizations.list

auth.authorizations.list(account_id: str, capability_key?: str | null, grant_kind?: "capability" | "account_owner" | "super_admin" | null, include_revoked?: bool, subject_id?: str | null, subject_type?: "user" | "group" | "service_account" | null) -> list[Session]
List account authorization grants.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/authorizations
NameTypeRequiredDescription
account_idstryesAccount UUID
capability_keystr | nullnoFilter by capability key
grant_kind"capability" | "account_owner" | "super_admin" | nullnoFilter by grant kind
include_revokedboolnoInclude revoked grants or assignments
subject_idstr | nullnoFilter by authorization subject ID
subject_type"user" | "group" | "service_account" | nullnoFilter by authorization subject type
FieldTypeRequiredDescription
grant_kindstryes
idstryes
subject_idstryes
subject_typestryes
capability_keystr | nullno
created_atstr | nullno
resource_idstr | nullno
resource_typestr | nullno
revoked_atstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.authorizations.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", capability_key=\"<string>\", grant_kind=\"<string>\", include_revoked=true, subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.authorizations.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.authorizations.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", capability_key=\"<string>\", grant_kind=\"<string>\", include_revoked=true, subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<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\": \"auth.authorizations.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.authorizations.revoke

auth.authorizations.revoke(account_id: str, grant_id: str) -> {}
Revoke account authorization grants.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
grant_idstryesAuthorization grant UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.authorizations.revoke(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", grant_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.authorizations.revoke",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.authorizations.revoke(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", grant_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\": \"auth.authorizations.revoke\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.create

auth.groups.create(account_id: str, payload: {"account_id": str, "name": str, "attributes"?: {} | null, "description"?: str | null}) -> Session
Create auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/groups
NameTypeRequiredDescription
account_idstryesAccount UUID
namestryes
attributes{} | nullno
descriptionstr | nullnoLocal group description
FieldTypeRequiredDescription
account_idstryes
idstryes
keycloak_namestryes
namestryes
attributes{}no
descriptionstr | nullno
keycloak_account_idstr | nullno
linked_scopes[{"resource_id": str, "resource_type": str}]no
parent_idstr | nullno
pathstr | nullno
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}no
subgroup_ids[str]no
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", payload=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.create",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", payload=\"<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\": \"auth.groups.create\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.delete

auth.groups.delete(account_id: str, group_id: str) -> {}
Delete auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_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\": \"auth.groups.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.get

auth.groups.get(account_id: str, group_id: str) -> Session
Get auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/groups/{group_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
FieldTypeRequiredDescription
account_idstryes
idstryes
keycloak_namestryes
namestryes
attributes{}no
descriptionstr | nullno
keycloak_account_idstr | nullno
linked_scopes[{"resource_id": str, "resource_type": str}]no
parent_idstr | nullno
pathstr | nullno
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}no
subgroup_ids[str]no
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.get",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_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\": \"auth.groups.get\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.invitations.create

auth.groups.invitations.create(account_id: str, group_id: str, email: str, locale?: str | null, note?: str | null) -> Session
Create auth group invitations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
emailstryesTarget email address
localestr | nullnoOptional locale for transactional invitation email
notestr | nullno
FieldTypeRequiredDescription
result{"assignments": [{"assignment_kind": str, "position": int, "capability_key"?: str | null, "grant_kind"?: str | null, "group_id"?: str | null, "id"?: str | null, "resource_id"?: str | null, "resource_type"?: str | null, "role_key"?: str | null}], "email": str, "id": str, "permission_context": {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "status": str, "accepted_at"?: str | null, "accepted_subject_id"?: str | null, "created_at"?: str | null, "expires_at"?: str | null, "note"?: str | null} | {"accepted_subject_id": str, "assignment_count": int, "email": str, "grant_count": int, "group_membership_count": int, "permission_context": {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "role_assignment_count": int, "mode"?: str, "status"?: str}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.invitations.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", email=\"user@example.com\", locale=\"<string>\", note=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.invitations.create",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.invitations.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", email=\"user@example.com\", locale=\"<string>\", note=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.groups.invitations.create\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.list

auth.groups.list(account_id: str) -> list[Session]
List auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/groups
NameTypeRequiredDescription
account_idstryesAccount UUID
FieldTypeRequiredDescription
account_idstryes
idstryes
keycloak_namestryes
namestryes
attributes{}no
descriptionstr | nullno
keycloak_account_idstr | nullno
linked_scopes[{"resource_id": str, "resource_type": str}]no
parent_idstr | nullno
pathstr | nullno
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}no
subgroup_ids[str]no
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.list(account_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\": \"auth.groups.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.members.add_group

auth.groups.members.add_group(account_id: str, group_id: str, child_group_id: str) -> Session
Add child groups to auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
child_group_idstryes
FieldTypeRequiredDescription
group_edgesintyes
groups_seenintyes
total_edgesintyes
user_edgesintyes
group_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.members.add_group(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", child_group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.members.add_group",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.members.add_group(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", child_group_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\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.groups.members.add_group\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.members.add_user

auth.groups.members.add_user(account_id: str, group_id: str, user_id: str) -> Session
Add users to auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
user_idstryes
FieldTypeRequiredDescription
group_edgesintyes
groups_seenintyes
total_edgesintyes
user_edgesintyes
group_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.members.add_user(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", user_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.members.add_user",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.members.add_user(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", user_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\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.groups.members.add_user\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.members.list

auth.groups.members.list(account_id: str, group_id: str, page?: int, page_size?: int, search?: str | null) -> Session
List auth group members.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
pageintno1-based result page
page_sizeintnoMaximum members per page
searchstr | nullnoOptional member search string
FieldTypeRequiredDescription
account_idstryes
group_idstryes
pageintyes
page_sizeintyes
totalintyes
groups[{"account_id": str, "id": str, "keycloak_name": str, "name": str, "attributes"?: {}, "description"?: str | null, "keycloak_account_id"?: str | null, "linked_scopes"?: [{"resource_id": str, "resource_type": str}], "parent_id"?: str | null, "path"?: str | null, "permission_context"?: {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "subgroup_ids"?: [str]}]no
linked_scopes[{"resource_id": str, "resource_type": str}]no
members[{"resolved": bool, "subject_id": str, "subject_type": str, "group"?: {"account_id": str, "id": str, "keycloak_name": str, "name": str, "attributes"?: {}, "description"?: str | null, "keycloak_account_id"?: str | null, "linked_scopes"?: [{"resource_id": str, "resource_type": str}], "parent_id"?: str | null, "path"?: str | null, "permission_context"?: {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "subgroup_ids"?: [str]} | null, "user"?: {"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null} | null}]no
searchstr | nullno
users[{"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null}]no
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.members.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123, search=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.members.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.members.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123, search=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.groups.members.list\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.members.remove_group

auth.groups.members.remove_group(account_id: str, child_group_id: str, group_id: str) -> Session
Remove child groups from auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
child_group_idstryesChild auth group ID from the route path
group_idstryesAuth group ID from the route path
FieldTypeRequiredDescription
group_edgesintyes
groups_seenintyes
total_edgesintyes
user_edgesintyes
group_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.members.remove_group(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", child_group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.members.remove_group",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.members.remove_group(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", child_group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_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\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.groups.members.remove_group\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.members.remove_user

auth.groups.members.remove_user(account_id: str, group_id: str, user_id: str) -> Session
Remove users from auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
user_idstryesAuth user ID from the route path
FieldTypeRequiredDescription
group_edgesintyes
groups_seenintyes
total_edgesintyes
user_edgesintyes
group_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.members.remove_user(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", user_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.members.remove_user",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.members.remove_user(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", user_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\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.groups.members.remove_user\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.groups.update

auth.groups.update(account_id: str, group_id: str, attributes?: {} | null, description?: str | null, name?: str | null) -> Session
Update auth groups.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/auth/groups/{group_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
group_idstryesAuth group ID from the route path
attributes{} | nullno
descriptionstr | nullno
namestr | nullno
FieldTypeRequiredDescription
account_idstryes
idstryes
keycloak_namestryes
namestryes
attributes{}no
descriptionstr | nullno
keycloak_account_idstr | nullno
linked_scopes[{"resource_id": str, "resource_type": str}]no
parent_idstr | nullno
pathstr | nullno
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}no
subgroup_ids[str]no
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", attributes=\"<string>\", description=\"<string>\", name=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.update",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", group_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", attributes=\"<string>\", description=\"<string>\", 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\": \"auth.groups.update\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.invitations.create

auth.invitations.create(account_id: str, assignments: [{"capability_key"?: str | null, "grant_kind"?: "capability" | "account_owner" | "super_admin" | null, "group_id"?: str | null, "resource_id"?: str | null, "resource_type"?: "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null, "role_key"?: str | null}], email: str, locale?: str | null, note?: str | null) -> Session
Create account invitations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/invitations
NameTypeRequiredDescription
account_idstryesAccount UUID
assignments[{"capability_key"?: str | null, "grant_kind"?: "capability" | "account_owner" | "super_admin" | null, "group_id"?: str | null, "resource_id"?: str | null, "resource_type"?: "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null, "role_key"?: str | null}]yes
emailstryesTarget email address
localestr | nullnoOptional locale for transactional invitation email
notestr | nullno
FieldTypeRequiredDescription
result{"assignments": [{"assignment_kind": str, "position": int, "capability_key"?: str | null, "grant_kind"?: str | null, "group_id"?: str | null, "id"?: str | null, "resource_id"?: str | null, "resource_type"?: str | null, "role_key"?: str | null}], "email": str, "id": str, "permission_context": {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "status": str, "accepted_at"?: str | null, "accepted_subject_id"?: str | null, "created_at"?: str | null, "expires_at"?: str | null, "note"?: str | null} | {"accepted_subject_id": str, "assignment_count": int, "email": str, "grant_count": int, "group_membership_count": int, "permission_context": {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "role_assignment_count": int, "mode"?: str, "status"?: str}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.invitations.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", assignments=\"<string>\", email=\"user@example.com\", locale=\"<string>\", note=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.create",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.invitations.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", assignments=\"<string>\", email=\"user@example.com\", locale=\"<string>\", note=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.invitations.create\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.invitations.delete

auth.invitations.delete(account_id: str, invitation_id: str) -> {}
Delete account invitations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
invitation_idstryesInvitation UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.invitations.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", invitation_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.invitations.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", invitation_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\": \"auth.invitations.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.invitations.list

auth.invitations.list(account_id: str, email?: str | null, status?: str | null) -> list[Session]
List account invitations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/invitations
NameTypeRequiredDescription
account_idstryesAccount UUID
emailstr | nullnoFilter invitations by recipient email
statusstr | nullnoFilter invitations by status
FieldTypeRequiredDescription
assignments[{"assignment_kind": str, "position": int, "capability_key"?: str | null, "grant_kind"?: str | null, "group_id"?: str | null, "id"?: str | null, "resource_id"?: str | null, "resource_type"?: str | null, "role_key"?: str | null}]yes
emailstryes
idstryes
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}yes
statusstryes
accepted_atstr | nullno
accepted_subject_idstr | nullno
created_atstr | nullno
expires_atstr | nullno
notestr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.invitations.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", email=\"user@example.com\", status=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.invitations.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", email=\"user@example.com\", status=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.invitations.list\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.invitations.resend

auth.invitations.resend(account_id: str, invitation_id: str, payload?: {"locale"?: str | null} | null) -> Session
Resend account invitations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend
NameTypeRequiredDescription
account_idstryesAccount UUID
invitation_idstryesInvitation UUID from the route path
payload{"locale"?: str | null} | nullyes
FieldTypeRequiredDescription
assignments[{"assignment_kind": str, "position": int, "capability_key"?: str | null, "grant_kind"?: str | null, "group_id"?: str | null, "id"?: str | null, "resource_id"?: str | null, "resource_type"?: str | null, "role_key"?: str | null}]yes
emailstryes
idstryes
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}yes
statusstryes
accepted_atstr | nullno
accepted_subject_idstr | nullno
created_atstr | nullno
expires_atstr | nullno
notestr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.invitations.resend(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", invitation_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", payload=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.resend",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.invitations.resend(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", invitation_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", payload=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.invitations.resend\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.invitations.update

auth.invitations.update(account_id: str, invitation_id: str, assignments: [{"capability_key"?: str | null, "grant_kind"?: "capability" | "account_owner" | "super_admin" | null, "group_id"?: str | null, "resource_id"?: str | null, "resource_type"?: "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null, "role_key"?: str | null}], note?: str | null) -> Session
Update account invitations.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
invitation_idstryesInvitation UUID from the route path
assignments[{"capability_key"?: str | null, "grant_kind"?: "capability" | "account_owner" | "super_admin" | null, "group_id"?: str | null, "resource_id"?: str | null, "resource_type"?: "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null, "role_key"?: str | null}]yes
notestr | nullno
FieldTypeRequiredDescription
assignments[{"assignment_kind": str, "position": int, "capability_key"?: str | null, "grant_kind"?: str | null, "group_id"?: str | null, "id"?: str | null, "resource_id"?: str | null, "resource_type"?: str | null, "role_key"?: str | null}]yes
emailstryes
idstryes
permission_context{"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}yes
statusstryes
accepted_atstr | nullno
accepted_subject_idstr | nullno
created_atstr | nullno
expires_atstr | nullno
notestr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.invitations.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", invitation_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", assignments=\"<string>\", note=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.invitations.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", invitation_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", assignments=\"<string>\", note=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.invitations.update\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.login

auth.login(identifier?: str, email?: str, username?: str, password?: str, service_account_token?: str) -> Session
Authenticate the runtime session.
PropertyValuePropertyValue
Requires permissionNoneAuth requiredno
Execution modesync
NameTypeRequiredDescription
identifierstrno
emailstrno
usernamestrno
passwordstrno
service_account_tokenstrno
FieldTypeRequiredDescription
authenticatedboolyes
principal_typestryes
user_idstrno
service_account_idstrno
emailstrno
usernamestrno
expires_atstryes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.login(identifier=\"<string>\", email=\"user@example.com\", username=\"<string>\", password=\"<string>\", service_account_token=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.login",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.login(identifier=\"<string>\", email=\"user@example.com\", username=\"<string>\", password=\"<string>\", service_account_token=\"<string>\")"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.login\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.logout

auth.logout() -> Session
Log out the runtime session.
PropertyValuePropertyValue
Requires permissionNoneAuth requiredno
Execution modesync
FieldTypeRequiredDescription
logged_outboolyes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.logout()"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "logged_out": true
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.logout",
      "status": "completed",
      "result": {
        "logged_out": true
      }
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.logout()"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"logged_out\": true\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.logout\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"logged_out\": true\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.role_assignments.create

auth.role_assignments.create(account_id: str, resource_id: str, resource_type: "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy", role_key: "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager", subject_id: str, subject_type: "user" | "group" | "service_account") -> Session
Create account role assignments.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/role-assignments
NameTypeRequiredDescription
account_idstryesAccount UUID
resource_idstryesAssignment scope resource identifier
resource_type"client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy"yesAssignment scope resource type
role_key"viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager"yesCode-defined role key
subject_idstryesUser, group, or service account identifier
subject_type"user" | "group" | "service_account"yesRole assignment subject type: user, group, or service_account
FieldTypeRequiredDescription
expanded_capability_keys[str]yes
idstryes
resource_idstryes
resource_typestryes
role_keystryes
subject_idstryes
subject_typestryes
created_atstr | nullno
revoked_atstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.role_assignments.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", resource_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", resource_type=\"<string>\", role_key=\"<string>\", subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.role_assignments.create",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.role_assignments.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", resource_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", resource_type=\"<string>\", role_key=\"<string>\", subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<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\": \"auth.role_assignments.create\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.role_assignments.delete

auth.role_assignments.delete(account_id: str, assignment_id: str) -> {}
Delete account role assignments.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
assignment_idstryesRole assignment UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.role_assignments.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", assignment_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.role_assignments.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.role_assignments.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", assignment_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\": \"auth.role_assignments.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.role_assignments.list

auth.role_assignments.list(account_id: str, include_revoked?: bool, role_key?: "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | null, subject_id?: str | null, subject_type?: "user" | "group" | "service_account" | null) -> list[Session]
List account role assignments.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/role-assignments
NameTypeRequiredDescription
account_idstryesAccount UUID
include_revokedboolnoInclude revoked grants or assignments
role_key"viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | nullnoFilter by authorization role key
subject_idstr | nullnoFilter by authorization subject ID
subject_type"user" | "group" | "service_account" | nullnoFilter by authorization subject type
FieldTypeRequiredDescription
expanded_capability_keys[str]yes
idstryes
resource_idstryes
resource_typestryes
role_keystryes
subject_idstryes
subject_typestryes
created_atstr | nullno
revoked_atstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.role_assignments.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", include_revoked=true, role_key=\"<string>\", subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.role_assignments.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.role_assignments.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", include_revoked=true, role_key=\"<string>\", subject_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", subject_type=\"<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\": \"auth.role_assignments.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.service_accounts.create

auth.service_accounts.create(account_id: str, name: str, expires_at?: str | null) -> Session
Create a service account and reveal its token once.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/service-accounts
NameTypeRequiredDescription
account_idstryesAccount UUID
namestryesHuman-readable service account name
expires_atstr | nullnoOptional UTC token expiry timestamp
FieldTypeRequiredDescription
account_idstryes
created_atstryes
idstryes
namestryes
tokenstryesPlaintext bearer token. Store it now; it is never returned again.
token_last4stryes
token_prefixstryes
token_public_idstryes
updated_atstryes
created_by_user_idstr | nullno
expires_atstr | nullno
last_used_atstr | nullno
revoked_atstr | nullno
revoked_by_user_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.service_accounts.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\", expires_at=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.create",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.service_accounts.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\", expires_at=\"<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\": \"auth.service_accounts.create\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.service_accounts.list

auth.service_accounts.list(account_id: str, include_revoked?: bool) -> list[Session]
List service accounts.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/service-accounts
NameTypeRequiredDescription
account_idstryesAccount UUID
include_revokedboolnoInclude revoked service accounts
FieldTypeRequiredDescription
account_idstryes
created_atstryes
idstryes
namestryes
token_last4stryes
token_prefixstryes
token_public_idstryes
updated_atstryes
created_by_user_idstr | nullno
expires_atstr | nullno
last_used_atstr | nullno
revoked_atstr | nullno
revoked_by_user_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.service_accounts.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", include_revoked=true)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.service_accounts.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", include_revoked=true)"
    }
  }
}
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\": \"auth.service_accounts.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.service_accounts.revoke

auth.service_accounts.revoke(account_id: str, service_account_id: str) -> {}
Revoke a service account.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}
NameTypeRequiredDescription
account_idstryesAccount UUID
service_account_idstryesService account UUID from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.service_accounts.revoke(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", service_account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.revoke",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.service_accounts.revoke(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", service_account_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\": \"auth.service_accounts.revoke\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.service_accounts.rotate

auth.service_accounts.rotate(account_id: str, service_account_id: str) -> Session
Rotate a service account token and reveal the replacement once.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate
NameTypeRequiredDescription
account_idstryesAccount UUID
service_account_idstryesService account UUID from the route path
FieldTypeRequiredDescription
account_idstryes
created_atstryes
idstryes
namestryes
tokenstryesPlaintext bearer token. Store it now; it is never returned again.
token_last4stryes
token_prefixstryes
token_public_idstryes
updated_atstryes
created_by_user_idstr | nullno
expires_atstr | nullno
last_used_atstr | nullno
revoked_atstr | nullno
revoked_by_user_idstr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.service_accounts.rotate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", service_account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.rotate",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.service_accounts.rotate(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", service_account_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\": \"auth.service_accounts.rotate\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.users.list

auth.users.list(account_id: str, limit?: int, search?: str | null) -> list[Session]
List auth users.
PropertyValuePropertyValue
Requires permissionauth.manageAuth requiredyes
Execution modesyncCapabilityauth.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/auth/users
NameTypeRequiredDescription
account_idstryesAccount UUID
limitintnoMaximum number of users to return
searchstr | nullnoOptional user search string
FieldTypeRequiredDescription
idstryes
emailstr | nullno
first_namestr | nullno
last_namestr | nullno
usernamestr | nullno
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.users.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", limit=123, search=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.users.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.users.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", limit=123, search=\"<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\": \"auth.users.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

auth.whoami

auth.whoami() -> Session
Describe the current runtime session.
PropertyValuePropertyValue
Requires permissionNoneAuth requiredno
Execution modesync
FieldTypeRequiredDescription
authenticatedboolyes
user_idstrno
emailstrno
usernamestrno
expires_atstryes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.whoami()"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.whoami",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.whoami()"
    }
  }
}
Response:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"auth.whoami\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}