Autenticação
Autenticar, encerrar e inspecionar a sessão de execução. Os exemplos usam o modo de código A2A. O MCP expõe o mesmo modo de código pela ferramentaexecute.
Funções
auth.authorizations.grant
auth.authorizations.grant.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/authorizations |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
grant_kind | "capability" | "account_owner" | "super_admin" | sim |
subject_id | str | sim |
subject_type | "user" | "group" | "service_account" | sim |
capability_key | str | null | não |
resource_id | str | null | não |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
grant_kind | str | sim |
id | str | sim |
subject_id | str | sim |
subject_type | str | sim |
capability_key | str | null | não |
created_at | str | null | não |
resource_id | str | null | não |
resource_type | str | null | não |
revoked_at | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.authorizations.list
auth.authorizations.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/authorizations |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
capability_key | str | null | não |
grant_kind | "capability" | "account_owner" | "super_admin" | null | não |
include_revoked | bool | não |
subject_id | str | null | não |
subject_type | "user" | "group" | "service_account" | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
grant_kind | str | sim |
id | str | sim |
subject_id | str | sim |
subject_type | str | sim |
capability_key | str | null | não |
created_at | str | null | não |
resource_id | str | null | não |
resource_type | str | null | não |
revoked_at | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.authorizations.revoke
auth.authorizations.revoke.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
grant_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.create
auth.groups.create.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/groups |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
name | str | sim |
attributes | {} | null | não |
description | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
id | str | sim |
keycloak_name | str | sim |
name | str | sim |
attributes | {} | não |
description | str | null | não |
keycloak_account_id | str | null | não |
linked_scopes | [{"resource_id": str, "resource_type": str}] | não |
parent_id | str | null | não |
path | str | null | não |
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} | não |
subgroup_ids | [str] | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.delete
auth.groups.delete.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.get
auth.groups.get.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
id | str | sim |
keycloak_name | str | sim |
name | str | sim |
attributes | {} | não |
description | str | null | não |
keycloak_account_id | str | null | não |
linked_scopes | [{"resource_id": str, "resource_type": str}] | não |
parent_id | str | null | não |
path | str | null | não |
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} | não |
subgroup_ids | [str] | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.invitations.create
auth.groups.invitations.create.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
email | str | sim |
locale | str | null | não |
note | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.list
auth.groups.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/groups |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
id | str | sim |
keycloak_name | str | sim |
name | str | sim |
attributes | {} | não |
description | str | null | não |
keycloak_account_id | str | null | não |
linked_scopes | [{"resource_id": str, "resource_type": str}] | não |
parent_id | str | null | não |
path | str | null | não |
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} | não |
subgroup_ids | [str] | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.members.add_group
auth.groups.members.add_group.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
child_group_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
group_edges | int | sim |
groups_seen | int | sim |
total_edges | int | sim |
user_edges | int | sim |
group_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.members.add_user
auth.groups.members.add_user.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
user_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
group_edges | int | sim |
groups_seen | int | sim |
total_edges | int | sim |
user_edges | int | sim |
group_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.members.list
auth.groups.members.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
page | int | não |
page_size | int | não |
search | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
page | int | sim |
page_size | int | sim |
total | int | sim |
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]}] | não |
linked_scopes | [{"resource_id": str, "resource_type": str}] | não |
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}] | não |
search | str | null | não |
users | [{"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null}] | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.members.remove_group
auth.groups.members.remove_group.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
child_group_id | str | sim |
group_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
group_edges | int | sim |
groups_seen | int | sim |
total_edges | int | sim |
user_edges | int | sim |
group_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.members.remove_user
auth.groups.members.remove_user.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
user_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
group_edges | int | sim |
groups_seen | int | sim |
total_edges | int | sim |
user_edges | int | sim |
group_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.groups.update
auth.groups.update.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
group_id | str | sim |
attributes | {} | null | não |
description | str | null | não |
name | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
id | str | sim |
keycloak_name | str | sim |
name | str | sim |
attributes | {} | não |
description | str | null | não |
keycloak_account_id | str | null | não |
linked_scopes | [{"resource_id": str, "resource_type": str}] | não |
parent_id | str | null | não |
path | str | null | não |
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} | não |
subgroup_ids | [str] | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.invitations.create
auth.invitations.create.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/invitations |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
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}] | sim |
email | str | sim |
locale | str | null | não |
note | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.invitations.delete
auth.invitations.delete.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
invitation_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.invitations.list
auth.invitations.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/invitations |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
email | str | null | não |
status | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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}] | sim |
email | str | sim |
id | str | sim |
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} | sim |
status | str | sim |
accepted_at | str | null | não |
accepted_subject_id | str | null | não |
created_at | str | null | não |
expires_at | str | null | não |
note | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.invitations.resend
auth.invitations.resend.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
invitation_id | str | sim |
payload | {"locale"?: str | null} | null | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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}] | sim |
email | str | sim |
id | str | sim |
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} | sim |
status | str | sim |
accepted_at | str | null | não |
accepted_subject_id | str | null | não |
created_at | str | null | não |
expires_at | str | null | não |
note | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.invitations.update
auth.invitations.update.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | PATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
invitation_id | str | sim |
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}] | sim |
note | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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}] | sim |
email | str | sim |
id | str | sim |
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} | sim |
status | str | sim |
accepted_at | str | null | não |
accepted_subject_id | str | null | não |
created_at | str | null | não |
expires_at | str | null | não |
note | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.login
auth.login.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | Nenhuma | Autenticação obrigatória | não |
| Modo de execução | sync |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
identifier | str | não |
email | str | não |
username | str | não |
password | str | não |
service_account_token | str | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
authenticated | bool | sim |
principal_type | str | sim |
user_id | str | não |
service_account_id | str | não |
email | str | não |
username | str | não |
expires_at | str | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.logout
auth.logout.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | Nenhuma | Autenticação obrigatória | não |
| Modo de execução | sync |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
logged_out | bool | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.role_assignments.create
auth.role_assignments.create.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/role-assignments |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
resource_id | str | sim |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | sim |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | sim |
subject_id | str | sim |
subject_type | "user" | "group" | "service_account" | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
expanded_capability_keys | [str] | sim |
id | str | sim |
resource_id | str | sim |
resource_type | str | sim |
role_key | str | sim |
subject_id | str | sim |
subject_type | str | sim |
created_at | str | null | não |
revoked_at | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.role_assignments.delete
auth.role_assignments.delete.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
assignment_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.role_assignments.list
auth.role_assignments.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/role-assignments |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
include_revoked | bool | não |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | null | não |
subject_id | str | null | não |
subject_type | "user" | "group" | "service_account" | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
expanded_capability_keys | [str] | sim |
id | str | sim |
resource_id | str | sim |
resource_type | str | sim |
role_key | str | sim |
subject_id | str | sim |
subject_type | str | sim |
created_at | str | null | não |
revoked_at | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.service_accounts.create
auth.service_accounts.create.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/service-accounts |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
name | str | sim |
expires_at | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
created_at | str | sim |
id | str | sim |
name | str | sim |
token | str | sim |
token_last4 | str | sim |
token_prefix | str | sim |
token_public_id | str | sim |
updated_at | str | sim |
created_by_user_id | str | null | não |
expires_at | str | null | não |
last_used_at | str | null | não |
revoked_at | str | null | não |
revoked_by_user_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.service_accounts.list
auth.service_accounts.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/service-accounts |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
include_revoked | bool | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
created_at | str | sim |
id | str | sim |
name | str | sim |
token_last4 | str | sim |
token_prefix | str | sim |
token_public_id | str | sim |
updated_at | str | sim |
created_by_user_id | str | null | não |
expires_at | str | null | não |
last_used_at | str | null | não |
revoked_at | str | null | não |
revoked_by_user_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.service_accounts.revoke
auth.service_accounts.revoke.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
service_account_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.service_accounts.rotate
auth.service_accounts.rotate.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
service_account_id | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
created_at | str | sim |
id | str | sim |
name | str | sim |
token | str | sim |
token_last4 | str | sim |
token_prefix | str | sim |
token_public_id | str | sim |
updated_at | str | sim |
created_by_user_id | str | null | não |
expires_at | str | null | não |
last_used_at | str | null | não |
revoked_at | str | null | não |
revoked_by_user_id | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.users.list
auth.users.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | auth.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | auth.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/auth/users |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
limit | int | não |
search | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
id | str | sim |
email | str | null | não |
first_name | str | null | não |
last_name | str | null | não |
username | str | null | não |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP
auth.whoami
auth.whoami.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | Nenhuma | Autenticação obrigatória | não |
| Modo de execução | sync |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
authenticated | bool | sim |
user_id | str | não |
email | str | não |
username | str | não |
expires_at | str | sim |
Exemplo A2A
Exemplo A2A
Exemplo MCP
Exemplo MCP