跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt

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

认证

对运行时会话进行身份验证、结束和检查。 示例使用 A2A 代码模式。MCP 通过 execute 工具公开相同的代码模式。

函数

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
认证: auth.authorizations.grant.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/authorizations
名称类型必需
account_idstr
grant_kind"capability" | "account_owner" | "super_admin"
subject_idstr
subject_type"user" | "group" | "service_account"
capability_keystr | null
resource_idstr | null
resource_type"client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null
字段类型必需
grant_kindstr
idstr
subject_idstr
subject_typestr
capability_keystr | null
created_atstr | null
resource_idstr | null
resource_typestr | null
revoked_atstr | null
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.authorizations.grant",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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]
认证: auth.authorizations.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/authorizations
名称类型必需
account_idstr
capability_keystr | null
grant_kind"capability" | "account_owner" | "super_admin" | null
include_revokedbool
subject_idstr | null
subject_type"user" | "group" | "service_account" | null
字段类型必需
grant_kindstr
idstr
subject_idstr
subject_typestr
capability_keystr | null
created_atstr | null
resource_idstr | null
resource_typestr | null
revoked_atstr | null
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.authorizations.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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) -> {}
认证: auth.authorizations.revoke.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id}
名称类型必需
account_idstr
grant_idstr
字段类型必需
result{}
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.authorizations.revoke",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.create.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/groups
名称类型必需
account_idstr
namestr
attributes{} | null
descriptionstr | null
字段类型必需
account_idstr
idstr
keycloak_namestr
namestr
attributes{}
descriptionstr | null
keycloak_account_idstr | null
linked_scopes[{"resource_id": str, "resource_type": str}]
parent_idstr | null
pathstr | 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]
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", payload=\"<string>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.create",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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) -> {}
认证: auth.groups.delete.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}
名称类型必需
account_idstr
group_idstr
字段类型必需
result{}
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.get.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/groups/{group_id}
名称类型必需
account_idstr
group_idstr
字段类型必需
account_idstr
idstr
keycloak_namestr
namestr
attributes{}
descriptionstr | null
keycloak_account_idstr | null
linked_scopes[{"resource_id": str, "resource_type": str}]
parent_idstr | null
pathstr | 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]
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.get",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.invitations.create.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations
名称类型必需
account_idstr
group_idstr
emailstr
localestr | null
notestr | null
字段类型必需
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}
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.invitations.create",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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]
认证: auth.groups.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/groups
名称类型必需
account_idstr
字段类型必需
account_idstr
idstr
keycloak_namestr
namestr
attributes{}
descriptionstr | null
keycloak_account_idstr | null
linked_scopes[{"resource_id": str, "resource_type": str}]
parent_idstr | null
pathstr | 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]
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.groups.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.groups.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.members.add_group.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups
名称类型必需
account_idstr
group_idstr
child_group_idstr
字段类型必需
group_edgesint
groups_seenint
total_edgesint
user_edgesint
group_idstr | null
请求:
{
  "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\")"
}
响应:
{
  "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
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.members.add_user.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users
名称类型必需
account_idstr
group_idstr
user_idstr
字段类型必需
group_edgesint
groups_seenint
total_edgesint
user_edgesint
group_idstr | null
请求:
{
  "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\")"
}
响应:
{
  "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
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.members.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members
名称类型必需
account_idstr
group_idstr
pageint
page_sizeint
searchstr | null
字段类型必需
account_idstr
group_idstr
pageint
page_sizeint
totalint
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]}]
linked_scopes[{"resource_id": str, "resource_type": str}]
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}]
searchstr | null
users[{"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null}]
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.members.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.members.remove_group.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id}
名称类型必需
account_idstr
child_group_idstr
group_idstr
字段类型必需
group_edgesint
groups_seenint
total_edgesint
user_edgesint
group_idstr | null
请求:
{
  "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\")"
}
响应:
{
  "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
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.members.remove_user.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id}
名称类型必需
account_idstr
group_idstr
user_idstr
字段类型必需
group_edgesint
groups_seenint
total_edgesint
user_edgesint
group_idstr | null
请求:
{
  "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\")"
}
响应:
{
  "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
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.groups.update.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id}
名称类型必需
account_idstr
group_idstr
attributes{} | null
descriptionstr | null
namestr | null
字段类型必需
account_idstr
idstr
keycloak_namestr
namestr
attributes{}
descriptionstr | null
keycloak_account_idstr | null
linked_scopes[{"resource_id": str, "resource_type": str}]
parent_idstr | null
pathstr | 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]
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.groups.update",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.invitations.create.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/invitations
名称类型必需
account_idstr
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}]
emailstr
localestr | null
notestr | null
字段类型必需
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}
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.create",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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) -> {}
认证: auth.invitations.delete.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}
名称类型必需
account_idstr
invitation_idstr
字段类型必需
result{}
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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]
认证: auth.invitations.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/invitations
名称类型必需
account_idstr
emailstr | null
statusstr | null
字段类型必需
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}]
emailstr
idstr
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}
statusstr
accepted_atstr | null
accepted_subject_idstr | null
created_atstr | null
expires_atstr | null
notestr | null
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.invitations.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", email=\"user@example.com\", status=\"<string>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.invitations.resend.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend
名称类型必需
account_idstr
invitation_idstr
payload{"locale"?: str | null} | null
字段类型必需
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}]
emailstr
idstr
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}
statusstr
accepted_atstr | null
accepted_subject_idstr | null
created_atstr | null
expires_atstr | null
notestr | null
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.resend",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.invitations.update.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由PATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}
名称类型必需
account_idstr
invitation_idstr
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}]
notestr | null
字段类型必需
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}]
emailstr
idstr
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}
statusstr
accepted_atstr | null
accepted_subject_idstr | null
created_atstr | null
expires_atstr | null
notestr | null
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.invitations.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.login.
属性属性
所需权限需要身份验证
执行模式sync
名称类型必需
identifierstr
emailstr
usernamestr
passwordstr
service_account_tokenstr
字段类型必需
authenticatedbool
principal_typestr
user_idstr
service_account_idstr
emailstr
usernamestr
expires_atstr
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.login(identifier=\"<string>\", email=\"user@example.com\", username=\"<string>\", password=\"<string>\", service_account_token=\"<string>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.login",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.logout.
属性属性
所需权限需要身份验证
执行模式sync
字段类型必需
logged_outbool
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.logout()"
}
响应:
{
  "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
}
请求:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.logout()"
    }
  }
}
响应:
{
  "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
认证: auth.role_assignments.create.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/role-assignments
名称类型必需
account_idstr
resource_idstr
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_idstr
subject_type"user" | "group" | "service_account"
字段类型必需
expanded_capability_keys[str]
idstr
resource_idstr
resource_typestr
role_keystr
subject_idstr
subject_typestr
created_atstr | null
revoked_atstr | null
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.role_assignments.create",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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) -> {}
认证: auth.role_assignments.delete.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id}
名称类型必需
account_idstr
assignment_idstr
字段类型必需
result{}
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.role_assignments.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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]
认证: auth.role_assignments.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/role-assignments
名称类型必需
account_idstr
include_revokedbool
role_key"viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | null
subject_idstr | null
subject_type"user" | "group" | "service_account" | null
字段类型必需
expanded_capability_keys[str]
idstr
resource_idstr
resource_typestr
role_keystr
subject_idstr
subject_typestr
created_atstr | null
revoked_atstr | null
请求:
{
  "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>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.role_assignments.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.service_accounts.create.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/service-accounts
名称类型必需
account_idstr
namestr
expires_atstr | null
字段类型必需
account_idstr
created_atstr
idstr
namestr
tokenstr
token_last4str
token_prefixstr
token_public_idstr
updated_atstr
created_by_user_idstr | null
expires_atstr | null
last_used_atstr | null
revoked_atstr | null
revoked_by_user_idstr | null
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.service_accounts.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", name=\"<string>\", expires_at=\"<string>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.create",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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]
认证: auth.service_accounts.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/service-accounts
名称类型必需
account_idstr
include_revokedbool
字段类型必需
account_idstr
created_atstr
idstr
namestr
token_last4str
token_prefixstr
token_public_idstr
updated_atstr
created_by_user_idstr | null
expires_atstr | null
last_used_atstr | null
revoked_atstr | null
revoked_by_user_idstr | null
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.service_accounts.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", include_revoked=true)"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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)"
    }
  }
}
响应:
{
  "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) -> {}
认证: auth.service_accounts.revoke.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由DELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}
名称类型必需
account_idstr
service_account_idstr
字段类型必需
result{}
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.revoke",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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
认证: auth.service_accounts.rotate.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由POST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate
名称类型必需
account_idstr
service_account_idstr
字段类型必需
account_idstr
created_atstr
idstr
namestr
tokenstr
token_last4str
token_prefixstr
token_public_idstr
updated_atstr
created_by_user_idstr | null
expires_atstr | null
last_used_atstr | null
revoked_atstr | null
revoked_by_user_idstr | null
请求:
{
  "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\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.service_accounts.rotate",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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\")"
    }
  }
}
响应:
{
  "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]
认证: auth.users.list.
属性属性
所需权限auth.manage需要身份验证
执行模式sync能力auth.manage
资源类型account资源 ID 字段account_id
公共 API 路由GET /v1/public/accounts/{account_id}/auth/users
名称类型必需
account_idstr
limitint
searchstr | null
字段类型必需
idstr
emailstr | null
first_namestr | null
last_namestr | null
usernamestr | null
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.users.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", limit=123, search=\"<string>\")"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.users.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
请求:
{
  "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>\")"
    }
  }
}
响应:
{
  "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
认证: auth.whoami.
属性属性
所需权限需要身份验证
执行模式sync
字段类型必需
authenticatedbool
user_idstr
emailstr
usernamestr
expires_atstr
请求:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "auth.whoami()"
}
响应:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "auth.whoami",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
请求:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "auth.whoami()"
    }
  }
}
响应:
{
  "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
  }
}