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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/authorizations | | |
| الاسم | النوع | مطلوب |
|---|
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 | لا |
| الحقل | النوع | مطلوب |
|---|
grant_kind | str | نعم |
id | str | نعم |
subject_id | str | نعم |
subject_type | str | نعم |
capability_key | str | null | لا |
created_at | str | null | لا |
resource_id | str | null | لا |
resource_type | str | null | لا |
revoked_at | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/authorizations | | |
| الاسم | النوع | مطلوب |
|---|
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 | لا |
| الحقل | النوع | مطلوب |
|---|
grant_kind | str | نعم |
id | str | نعم |
subject_id | str | نعم |
subject_type | str | نعم |
capability_key | str | null | لا |
created_at | str | null | لا |
resource_id | str | null | لا |
resource_type | str | null | لا |
revoked_at | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
grant_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/groups | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
name | str | نعم |
attributes | {} | null | لا |
description | str | null | لا |
| الحقل | النوع | مطلوب |
|---|
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] | لا |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/groups/{group_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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] | لا |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
email | str | نعم |
locale | str | null | لا |
note | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/groups | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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] | لا |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
child_group_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
group_edges | int | نعم |
groups_seen | int | نعم |
total_edges | int | نعم |
user_edges | int | نعم |
group_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
user_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
group_edges | int | نعم |
groups_seen | int | نعم |
total_edges | int | نعم |
user_edges | int | نعم |
group_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
page | int | لا |
page_size | int | لا |
search | str | null | لا |
| الحقل | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
page | int | نعم |
page_size | int | نعم |
total | int | نعم |
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}] | لا |
search | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
child_group_id | str | نعم |
group_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
group_edges | int | نعم |
groups_seen | int | نعم |
total_edges | int | نعم |
user_edges | int | نعم |
group_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
user_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
group_edges | int | نعم |
groups_seen | int | نعم |
total_edges | int | نعم |
user_edges | int | نعم |
group_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
group_id | str | نعم |
attributes | {} | null | لا |
description | str | null | لا |
name | str | null | لا |
| الحقل | النوع | مطلوب |
|---|
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] | لا |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/invitations | | |
| الاسم | النوع | مطلوب |
|---|
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 | لا |
| الحقل | النوع | مطلوب |
|---|
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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
invitation_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/invitations | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
email | str | null | لا |
status | str | 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}] | نعم |
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 | لا |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
invitation_id | str | نعم |
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}] | نعم |
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 | لا |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | PATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} | | |
| الاسم | النوع | مطلوب |
|---|
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 | لا |
| الحقل | النوع | مطلوب |
|---|
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 | لا |
الطلب:{
"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 | | |
| الاسم | النوع | مطلوب |
|---|
identifier | str | لا |
email | str | لا |
username | str | لا |
password | str | لا |
service_account_token | str | لا |
| الحقل | النوع | مطلوب |
|---|
authenticated | bool | نعم |
principal_type | str | نعم |
user_id | str | لا |
service_account_id | str | لا |
email | str | لا |
username | str | لا |
expires_at | str | نعم |
الطلب:{
"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.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | لا شيء | المصادقة مطلوبة | لا |
| وضع التنفيذ | sync | | |
| الحقل | النوع | مطلوب |
|---|
logged_out | bool | نعم |
الطلب:{
"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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/role-assignments | | |
| الاسم | النوع | مطلوب |
|---|
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" | نعم |
| الحقل | النوع | مطلوب |
|---|
expanded_capability_keys | [str] | نعم |
id | str | نعم |
resource_id | str | نعم |
resource_type | str | نعم |
role_key | str | نعم |
subject_id | str | نعم |
subject_type | str | نعم |
created_at | str | null | لا |
revoked_at | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
assignment_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/role-assignments | | |
| الاسم | النوع | مطلوب |
|---|
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 | لا |
| الحقل | النوع | مطلوب |
|---|
expanded_capability_keys | [str] | نعم |
id | str | نعم |
resource_id | str | نعم |
resource_type | str | نعم |
role_key | str | نعم |
subject_id | str | نعم |
subject_type | str | نعم |
created_at | str | null | لا |
revoked_at | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/service-accounts | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
name | str | نعم |
expires_at | str | null | لا |
| الحقل | النوع | مطلوب |
|---|
account_id | str | نعم |
created_at | str | نعم |
id | str | نعم |
name | str | نعم |
token | str | نعم |
token_last4 | str | نعم |
token_prefix | str | نعم |
token_public_id | str | نعم |
updated_at | str | نعم |
created_by_user_id | str | null | لا |
expires_at | str | null | لا |
last_used_at | str | null | لا |
revoked_at | str | null | لا |
revoked_by_user_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/service-accounts | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
include_revoked | bool | لا |
| الحقل | النوع | مطلوب |
|---|
account_id | str | نعم |
created_at | str | نعم |
id | str | نعم |
name | str | نعم |
token_last4 | str | نعم |
token_prefix | str | نعم |
token_public_id | str | نعم |
updated_at | str | نعم |
created_by_user_id | str | null | لا |
expires_at | str | null | لا |
last_used_at | str | null | لا |
revoked_at | str | null | لا |
revoked_by_user_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | DELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id} | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
service_account_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
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 | حقل معرف المورد | account_id |
| مسار API العام | POST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
service_account_id | str | نعم |
| الحقل | النوع | مطلوب |
|---|
account_id | str | نعم |
created_at | str | نعم |
id | str | نعم |
name | str | نعم |
token | str | نعم |
token_last4 | str | نعم |
token_prefix | str | نعم |
token_public_id | str | نعم |
updated_at | str | نعم |
created_by_user_id | str | null | لا |
expires_at | str | null | لا |
last_used_at | str | null | لا |
revoked_at | str | null | لا |
revoked_by_user_id | str | 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 | حقل معرف المورد | account_id |
| مسار API العام | GET /v1/public/accounts/{account_id}/auth/users | | |
| الاسم | النوع | مطلوب |
|---|
account_id | str | نعم |
limit | int | لا |
search | str | null | لا |
| الحقل | النوع | مطلوب |
|---|
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.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.
| الخاصية | القيمة | الخاصية | القيمة |
|---|
| الإذن المطلوب | لا شيء | المصادقة مطلوبة | لا |
| وضع التنفيذ | sync | | |
| الحقل | النوع | مطلوب |
|---|
authenticated | bool | نعم |
user_id | str | لا |
email | str | لا |
username | str | لا |
expires_at | str | نعم |
الطلب:{
"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
}
}