Authentifizierung
Die Laufzeitsitzung authentifizieren, beenden und prüfen. Die Beispiele verwenden den A2A-Code-Modus. MCP stellt denselben Code-Modus über sein Toolexecute bereit.
Funktionen
auth.authorizations.grant
auth.authorizations.grant.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/authorizations |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
grant_kind | "capability" | "account_owner" | "super_admin" | ja |
subject_id | str | ja |
subject_type | "user" | "group" | "service_account" | ja |
capability_key | str | null | nein |
resource_id | str | null | nein |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
grant_kind | str | ja |
id | str | ja |
subject_id | str | ja |
subject_type | str | ja |
capability_key | str | null | nein |
created_at | str | null | nein |
resource_id | str | null | nein |
resource_type | str | null | nein |
revoked_at | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.authorizations.list
auth.authorizations.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/authorizations |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
capability_key | str | null | nein |
grant_kind | "capability" | "account_owner" | "super_admin" | null | nein |
include_revoked | bool | nein |
subject_id | str | null | nein |
subject_type | "user" | "group" | "service_account" | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
grant_kind | str | ja |
id | str | ja |
subject_id | str | ja |
subject_type | str | ja |
capability_key | str | null | nein |
created_at | str | null | nein |
resource_id | str | null | nein |
resource_type | str | null | nein |
revoked_at | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.authorizations.revoke
auth.authorizations.revoke.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
grant_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
result | {} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.create
auth.groups.create.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/groups |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
name | str | ja |
attributes | {} | null | nein |
description | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
id | str | ja |
keycloak_name | str | ja |
name | str | ja |
attributes | {} | nein |
description | str | null | nein |
keycloak_account_id | str | null | nein |
linked_scopes | [{"resource_id": str, "resource_type": str}] | nein |
parent_id | str | null | nein |
path | str | null | nein |
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} | nein |
subgroup_ids | [str] | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.delete
auth.groups.delete.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
result | {} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.get
auth.groups.get.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
id | str | ja |
keycloak_name | str | ja |
name | str | ja |
attributes | {} | nein |
description | str | null | nein |
keycloak_account_id | str | null | nein |
linked_scopes | [{"resource_id": str, "resource_type": str}] | nein |
parent_id | str | null | nein |
path | str | null | nein |
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} | nein |
subgroup_ids | [str] | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.invitations.create
auth.groups.invitations.create.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
email | str | ja |
locale | str | null | nein |
note | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
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} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.list
auth.groups.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/groups |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
id | str | ja |
keycloak_name | str | ja |
name | str | ja |
attributes | {} | nein |
description | str | null | nein |
keycloak_account_id | str | null | nein |
linked_scopes | [{"resource_id": str, "resource_type": str}] | nein |
parent_id | str | null | nein |
path | str | null | nein |
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} | nein |
subgroup_ids | [str] | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.members.add_group
auth.groups.members.add_group.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
child_group_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
group_edges | int | ja |
groups_seen | int | ja |
total_edges | int | ja |
user_edges | int | ja |
group_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.members.add_user
auth.groups.members.add_user.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
user_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
group_edges | int | ja |
groups_seen | int | ja |
total_edges | int | ja |
user_edges | int | ja |
group_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.members.list
auth.groups.members.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
page | int | nein |
page_size | int | nein |
search | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
page | int | ja |
page_size | int | ja |
total | int | ja |
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]}] | nein |
linked_scopes | [{"resource_id": str, "resource_type": str}] | nein |
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}] | nein |
search | str | null | nein |
users | [{"id": str, "email"?: str | null, "first_name"?: str | null, "last_name"?: str | null, "username"?: str | null}] | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.members.remove_group
auth.groups.members.remove_group.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
child_group_id | str | ja |
group_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
group_edges | int | ja |
groups_seen | int | ja |
total_edges | int | ja |
user_edges | int | ja |
group_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.members.remove_user
auth.groups.members.remove_user.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
user_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
group_edges | int | ja |
groups_seen | int | ja |
total_edges | int | ja |
user_edges | int | ja |
group_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.groups.update
auth.groups.update.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
group_id | str | ja |
attributes | {} | null | nein |
description | str | null | nein |
name | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
id | str | ja |
keycloak_name | str | ja |
name | str | ja |
attributes | {} | nein |
description | str | null | nein |
keycloak_account_id | str | null | nein |
linked_scopes | [{"resource_id": str, "resource_type": str}] | nein |
parent_id | str | null | nein |
path | str | null | nein |
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} | nein |
subgroup_ids | [str] | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.invitations.create
auth.invitations.create.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/invitations |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
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}] | ja |
email | str | ja |
locale | str | null | nein |
note | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
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} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.invitations.delete
auth.invitations.delete.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
invitation_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
result | {} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.invitations.list
auth.invitations.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/invitations |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
email | str | null | nein |
status | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
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}] | ja |
email | str | ja |
id | str | ja |
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} | ja |
status | str | ja |
accepted_at | str | null | nein |
accepted_subject_id | str | null | nein |
created_at | str | null | nein |
expires_at | str | null | nein |
note | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.invitations.resend
auth.invitations.resend.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
invitation_id | str | ja |
payload | {"locale"?: str | null} | null | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
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}] | ja |
email | str | ja |
id | str | ja |
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} | ja |
status | str | ja |
accepted_at | str | null | nein |
accepted_subject_id | str | null | nein |
created_at | str | null | nein |
expires_at | str | null | nein |
note | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.invitations.update
auth.invitations.update.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | PATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
invitation_id | str | ja |
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}] | ja |
note | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
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}] | ja |
email | str | ja |
id | str | ja |
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} | ja |
status | str | ja |
accepted_at | str | null | nein |
accepted_subject_id | str | null | nein |
created_at | str | null | nein |
expires_at | str | null | nein |
note | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.login
auth.login.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | Keine | Authentifizierung erforderlich | nein |
| Ausführungsmodus | sync |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
identifier | str | nein |
email | str | nein |
username | str | nein |
password | str | nein |
service_account_token | str | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
authenticated | bool | ja |
principal_type | str | ja |
user_id | str | nein |
service_account_id | str | nein |
email | str | nein |
username | str | nein |
expires_at | str | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.logout
auth.logout.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | Keine | Authentifizierung erforderlich | nein |
| Ausführungsmodus | sync |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
logged_out | bool | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.role_assignments.create
auth.role_assignments.create.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/role-assignments |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
resource_id | str | ja |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | ja |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | ja |
subject_id | str | ja |
subject_type | "user" | "group" | "service_account" | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
expanded_capability_keys | [str] | ja |
id | str | ja |
resource_id | str | ja |
resource_type | str | ja |
role_key | str | ja |
subject_id | str | ja |
subject_type | str | ja |
created_at | str | null | nein |
revoked_at | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.role_assignments.delete
auth.role_assignments.delete.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
assignment_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
result | {} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.role_assignments.list
auth.role_assignments.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/role-assignments |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
include_revoked | bool | nein |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | null | nein |
subject_id | str | null | nein |
subject_type | "user" | "group" | "service_account" | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
expanded_capability_keys | [str] | ja |
id | str | ja |
resource_id | str | ja |
resource_type | str | ja |
role_key | str | ja |
subject_id | str | ja |
subject_type | str | ja |
created_at | str | null | nein |
revoked_at | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.service_accounts.create
auth.service_accounts.create.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/service-accounts |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
name | str | ja |
expires_at | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
created_at | str | ja |
id | str | ja |
name | str | ja |
token | str | ja |
token_last4 | str | ja |
token_prefix | str | ja |
token_public_id | str | ja |
updated_at | str | ja |
created_by_user_id | str | null | nein |
expires_at | str | null | nein |
last_used_at | str | null | nein |
revoked_at | str | null | nein |
revoked_by_user_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.service_accounts.list
auth.service_accounts.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/service-accounts |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
include_revoked | bool | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
created_at | str | ja |
id | str | ja |
name | str | ja |
token_last4 | str | ja |
token_prefix | str | ja |
token_public_id | str | ja |
updated_at | str | ja |
created_by_user_id | str | null | nein |
expires_at | str | null | nein |
last_used_at | str | null | nein |
revoked_at | str | null | nein |
revoked_by_user_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.service_accounts.revoke
auth.service_accounts.revoke.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | DELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id} |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
service_account_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
result | {} | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.service_accounts.rotate
auth.service_accounts.rotate.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | POST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
service_account_id | str | ja |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
created_at | str | ja |
id | str | ja |
name | str | ja |
token | str | ja |
token_last4 | str | ja |
token_prefix | str | ja |
token_public_id | str | ja |
updated_at | str | ja |
created_by_user_id | str | null | nein |
expires_at | str | null | nein |
last_used_at | str | null | nein |
revoked_at | str | null | nein |
revoked_by_user_id | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.users.list
auth.users.list.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | auth.manage | Authentifizierung erforderlich | ja |
| Ausführungsmodus | sync | Fähigkeit | auth.manage |
| Ressourcentyp | account | Ressourcen-ID-Feld | account_id |
| Öffentliche API-Route | GET /v1/public/accounts/{account_id}/auth/users |
Argumente
Argumente
| Name | Typ | Erforderlich |
|---|---|---|
account_id | str | ja |
limit | int | nein |
search | str | null | nein |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
id | str | ja |
email | str | null | nein |
first_name | str | null | nein |
last_name | str | null | nein |
username | str | null | nein |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel
auth.whoami
auth.whoami.
| Eigenschaft | Wert | Eigenschaft | Wert |
|---|---|---|---|
| Erforderliche Berechtigung | Keine | Authentifizierung erforderlich | nein |
| Ausführungsmodus | sync |
Rückgabe
Rückgabe
| Feld | Typ | Erforderlich |
|---|---|---|
authenticated | bool | ja |
user_id | str | nein |
email | str | nein |
username | str | nein |
expires_at | str | ja |
A2A-Beispiel
A2A-Beispiel
MCP-Beispiel
MCP-Beispiel