Autenticazione
Autenticare, terminare e ispezionare la sessione runtime. Gli esempi usano la modalità codice A2A. MCP espone la stessa modalità codice tramite lo strumentoexecute.
Funzioni
auth.authorizations.grant
auth.authorizations.grant.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/authorizations |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
grant_kind | "capability" | "account_owner" | "super_admin" | sì |
subject_id | str | sì |
subject_type | "user" | "group" | "service_account" | sì |
capability_key | str | null | no |
resource_id | str | null | no |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
grant_kind | str | sì |
id | str | sì |
subject_id | str | sì |
subject_type | str | sì |
capability_key | str | null | no |
created_at | str | null | no |
resource_id | str | null | no |
resource_type | str | null | no |
revoked_at | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.authorizations.list
auth.authorizations.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/authorizations |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
capability_key | str | null | no |
grant_kind | "capability" | "account_owner" | "super_admin" | null | no |
include_revoked | bool | no |
subject_id | str | null | no |
subject_type | "user" | "group" | "service_account" | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
grant_kind | str | sì |
id | str | sì |
subject_id | str | sì |
subject_type | str | sì |
capability_key | str | null | no |
created_at | str | null | no |
resource_id | str | null | no |
resource_type | str | null | no |
revoked_at | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.authorizations.revoke
auth.authorizations.revoke.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
grant_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
result | {} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.create
auth.groups.create.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/groups |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
name | str | sì |
attributes | {} | null | no |
description | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
id | str | sì |
keycloak_name | str | sì |
name | str | sì |
attributes | {} | no |
description | str | null | no |
keycloak_account_id | str | null | no |
linked_scopes | [{"resource_id": str, "resource_type": str}] | no |
parent_id | str | null | no |
path | str | null | no |
permission_context | {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str} | no |
subgroup_ids | [str] | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.delete
auth.groups.delete.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
result | {} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.get
auth.groups.get.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
id | str | sì |
keycloak_name | str | sì |
name | str | sì |
attributes | {} | no |
description | str | null | no |
keycloak_account_id | str | null | no |
linked_scopes | [{"resource_id": str, "resource_type": str}] | no |
parent_id | str | null | no |
path | str | null | no |
permission_context | {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str} | no |
subgroup_ids | [str] | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.invitations.create
auth.groups.invitations.create.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
email | str | sì |
locale | str | null | no |
note | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
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} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.list
auth.groups.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/groups |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
id | str | sì |
keycloak_name | str | sì |
name | str | sì |
attributes | {} | no |
description | str | null | no |
keycloak_account_id | str | null | no |
linked_scopes | [{"resource_id": str, "resource_type": str}] | no |
parent_id | str | null | no |
path | str | null | no |
permission_context | {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str} | no |
subgroup_ids | [str] | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.members.add_group
auth.groups.members.add_group.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
child_group_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
group_edges | int | sì |
groups_seen | int | sì |
total_edges | int | sì |
user_edges | int | sì |
group_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.members.add_user
auth.groups.members.add_user.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
user_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
group_edges | int | sì |
groups_seen | int | sì |
total_edges | int | sì |
user_edges | int | sì |
group_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.members.list
auth.groups.members.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
page | int | no |
page_size | int | no |
search | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
page | int | sì |
page_size | int | sì |
total | int | sì |
groups | [{"account_id": str, "id": str, "keycloak_name": str, "name": str, "attributes"?: {}, "description"?: str | null, "keycloak_account_id"?: str | null, "linked_scopes"?: [{"resource_id": str, "resource_type": str}], "parent_id"?: str | null, "path"?: str | null, "permission_context"?: {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "subgroup_ids"?: [str]}] | no |
linked_scopes | [{"resource_id": str, "resource_type": str}] | no |
members | [{"resolved": bool, "subject_id": str, "subject_type": str, "group"?: {"account_id": str, "id": str, "keycloak_name": str, "name": str, "attributes"?: {}, "description"?: str | null, "keycloak_account_id"?: str | null, "linked_scopes"?: [{"resource_id": str, "resource_type": str}], "parent_id"?: str | null, "path"?: str | null, "permission_context"?: {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str}, "subgroup_ids"?: [str]} | null, "user"?: {"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null} | null}] | no |
search | str | null | no |
users | [{"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null}] | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.members.remove_group
auth.groups.members.remove_group.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
child_group_id | str | sì |
group_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
group_edges | int | sì |
groups_seen | int | sì |
total_edges | int | sì |
user_edges | int | sì |
group_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.members.remove_user
auth.groups.members.remove_user.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
user_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
group_edges | int | sì |
groups_seen | int | sì |
total_edges | int | sì |
user_edges | int | sì |
group_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.groups.update
auth.groups.update.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
group_id | str | sì |
attributes | {} | null | no |
description | str | null | no |
name | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
id | str | sì |
keycloak_name | str | sì |
name | str | sì |
attributes | {} | no |
description | str | null | no |
keycloak_account_id | str | null | no |
linked_scopes | [{"resource_id": str, "resource_type": str}] | no |
parent_id | str | null | no |
path | str | null | no |
permission_context | {"assigned_bundle_keys"?: [str], "direct_capability_keys"?: [str], "owner_assignments"?: [{"account_id": str}], "resolved_capability_keys"?: [str], "status"?: str, "subject_id"?: str, "subject_type"?: str} | no |
subgroup_ids | [str] | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.invitations.create
auth.invitations.create.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/invitations |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
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}] | sì |
email | str | sì |
locale | str | null | no |
note | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
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} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.invitations.delete
auth.invitations.delete.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
invitation_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
result | {} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.invitations.list
auth.invitations.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/invitations |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
email | str | null | no |
status | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
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}] | sì |
email | str | sì |
id | str | sì |
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} | sì |
status | str | sì |
accepted_at | str | null | no |
accepted_subject_id | str | null | no |
created_at | str | null | no |
expires_at | str | null | no |
note | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.invitations.resend
auth.invitations.resend.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
invitation_id | str | sì |
payload | {"locale"?: str | null} | null | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
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}] | sì |
email | str | sì |
id | str | sì |
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} | sì |
status | str | sì |
accepted_at | str | null | no |
accepted_subject_id | str | null | no |
created_at | str | null | no |
expires_at | str | null | no |
note | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.invitations.update
auth.invitations.update.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | PATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
invitation_id | str | sì |
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}] | sì |
note | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
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}] | sì |
email | str | sì |
id | str | sì |
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} | sì |
status | str | sì |
accepted_at | str | null | no |
accepted_subject_id | str | null | no |
created_at | str | null | no |
expires_at | str | null | no |
note | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.login
auth.login.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | Nessuna | Autenticazione richiesta | no |
| Modalità di esecuzione | sync |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
identifier | str | no |
email | str | no |
username | str | no |
password | str | no |
service_account_token | str | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
authenticated | bool | sì |
principal_type | str | sì |
user_id | str | no |
service_account_id | str | no |
email | str | no |
username | str | no |
expires_at | str | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.logout
auth.logout.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | Nessuna | Autenticazione richiesta | no |
| Modalità di esecuzione | sync |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
logged_out | bool | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.role_assignments.create
auth.role_assignments.create.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/role-assignments |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
resource_id | str | sì |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | sì |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | sì |
subject_id | str | sì |
subject_type | "user" | "group" | "service_account" | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
expanded_capability_keys | [str] | sì |
id | str | sì |
resource_id | str | sì |
resource_type | str | sì |
role_key | str | sì |
subject_id | str | sì |
subject_type | str | sì |
created_at | str | null | no |
revoked_at | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.role_assignments.delete
auth.role_assignments.delete.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
assignment_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
result | {} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.role_assignments.list
auth.role_assignments.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/role-assignments |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
include_revoked | bool | no |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | null | no |
subject_id | str | null | no |
subject_type | "user" | "group" | "service_account" | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
expanded_capability_keys | [str] | sì |
id | str | sì |
resource_id | str | sì |
resource_type | str | sì |
role_key | str | sì |
subject_id | str | sì |
subject_type | str | sì |
created_at | str | null | no |
revoked_at | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.service_accounts.create
auth.service_accounts.create.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/service-accounts |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
name | str | sì |
expires_at | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
created_at | str | sì |
id | str | sì |
name | str | sì |
token | str | sì |
token_last4 | str | sì |
token_prefix | str | sì |
token_public_id | str | sì |
updated_at | str | sì |
created_by_user_id | str | null | no |
expires_at | str | null | no |
last_used_at | str | null | no |
revoked_at | str | null | no |
revoked_by_user_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.service_accounts.list
auth.service_accounts.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/service-accounts |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
include_revoked | bool | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
created_at | str | sì |
id | str | sì |
name | str | sì |
token_last4 | str | sì |
token_prefix | str | sì |
token_public_id | str | sì |
updated_at | str | sì |
created_by_user_id | str | null | no |
expires_at | str | null | no |
last_used_at | str | null | no |
revoked_at | str | null | no |
revoked_by_user_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.service_accounts.revoke
auth.service_accounts.revoke.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | DELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id} |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
service_account_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
result | {} | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.service_accounts.rotate
auth.service_accounts.rotate.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | POST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
service_account_id | str | sì |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
created_at | str | sì |
id | str | sì |
name | str | sì |
token | str | sì |
token_last4 | str | sì |
token_prefix | str | sì |
token_public_id | str | sì |
updated_at | str | sì |
created_by_user_id | str | null | no |
expires_at | str | null | no |
last_used_at | str | null | no |
revoked_at | str | null | no |
revoked_by_user_id | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.users.list
auth.users.list.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | auth.manage | Autenticazione richiesta | sì |
| Modalità di esecuzione | sync | Capacità | auth.manage |
| Tipo di risorsa | account | Campo ID risorsa | account_id |
| Route API pubblica | GET /v1/public/accounts/{account_id}/auth/users |
Argomenti
Argomenti
| Nome | Tipo | Obbligatorio |
|---|---|---|
account_id | str | sì |
limit | int | no |
search | str | null | no |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
id | str | sì |
email | str | null | no |
first_name | str | null | no |
last_name | str | null | no |
username | str | null | no |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP
auth.whoami
auth.whoami.
| Proprietà | Valore | Proprietà | Valore |
|---|---|---|---|
| Autorizzazione richiesta | Nessuna | Autenticazione richiesta | no |
| Modalità di esecuzione | sync |
Restituisce
Restituisce
| Campo | Tipo | Obbligatorio |
|---|---|---|
authenticated | bool | sì |
user_id | str | no |
email | str | no |
username | str | no |
expires_at | str | sì |
Esempio A2A
Esempio A2A
Esempio MCP
Esempio MCP