Auth
Authenticate, end, and inspect the runtime session. The examples use A2A code mode. MCP exposes the same code mode through itsexecute tool.
Functions
auth.authorizations.grant
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/authorizations |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
grant_kind | "capability" | "account_owner" | "super_admin" | yes | Grant kind |
subject_id | str | yes | User or group identifier |
subject_type | "user" | "group" | "service_account" | yes | Subject type: user or group |
capability_key | str | null | no | Capability key for capability grants |
resource_id | str | null | no | Scoped resource identifier |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | null | no | Scoped resource type |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
grant_kind | str | yes | |
id | str | yes | |
subject_id | str | yes | |
subject_type | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.authorizations.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/authorizations |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
capability_key | str | null | no | Filter by capability key |
grant_kind | "capability" | "account_owner" | "super_admin" | null | no | Filter by grant kind |
include_revoked | bool | no | Include revoked grants or assignments |
subject_id | str | null | no | Filter by authorization subject ID |
subject_type | "user" | "group" | "service_account" | null | no | Filter by authorization subject type |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
grant_kind | str | yes | |
id | str | yes | |
subject_id | str | yes | |
subject_type | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.authorizations.revoke
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/authorizations/{grant_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
grant_id | str | yes | Authorization grant UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
MCP example
MCP example
auth.groups.create
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/groups |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
name | str | yes | |
attributes | {} | null | no | |
description | str | null | no | Local group description |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
id | str | yes | |
keycloak_name | str | yes | |
name | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.groups.delete
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
MCP example
MCP example
auth.groups.get
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
id | str | yes | |
keycloak_name | str | yes | |
name | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.groups.invitations.create
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/invitations |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
email | str | yes | Target email address |
locale | str | null | no | Optional locale for transactional invitation email |
note | str | null | no |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
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} | yes |
A2A example
A2A example
MCP example
MCP example
auth.groups.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/groups |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
id | str | yes | |
keycloak_name | str | yes | |
name | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.groups.members.add_group
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
child_group_id | str | yes |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
group_edges | int | yes | |
groups_seen | int | yes | |
total_edges | int | yes | |
user_edges | int | yes | |
group_id | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.groups.members.add_user
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
user_id | str | yes |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
group_edges | int | yes | |
groups_seen | int | yes | |
total_edges | int | yes | |
user_edges | int | yes | |
group_id | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.groups.members.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/groups/{group_id}/members |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
page | int | no | 1-based result page |
page_size | int | no | Maximum members per page |
search | str | null | no | Optional member search string |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
group_id | str | yes | |
page | int | yes | |
page_size | int | yes | |
total | int | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.groups.members.remove_group
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/groups/{child_group_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
child_group_id | str | yes | Child auth group ID from the route path |
group_id | str | yes | Auth group ID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
group_edges | int | yes | |
groups_seen | int | yes | |
total_edges | int | yes | |
user_edges | int | yes | |
group_id | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.groups.members.remove_user
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/groups/{group_id}/members/users/{user_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
user_id | str | yes | Auth user ID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
group_edges | int | yes | |
groups_seen | int | yes | |
total_edges | int | yes | |
user_edges | int | yes | |
group_id | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.groups.update
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | PATCH /v1/public/accounts/{account_id}/auth/groups/{group_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
group_id | str | yes | Auth group ID from the route path |
attributes | {} | null | no | |
description | str | null | no | |
name | str | null | no |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
id | str | yes | |
keycloak_name | str | yes | |
name | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.invitations.create
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/invitations |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
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}] | yes | |
email | str | yes | Target email address |
locale | str | null | no | Optional locale for transactional invitation email |
note | str | null | no |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
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} | yes |
A2A example
A2A example
MCP example
MCP example
auth.invitations.delete
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
invitation_id | str | yes | Invitation UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
MCP example
MCP example
auth.invitations.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/invitations |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
email | str | null | no | Filter invitations by recipient email |
status | str | null | no | Filter invitations by status |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
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}] | yes | |
email | str | yes | |
id | str | yes | |
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} | yes | |
status | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.invitations.resend
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/invitations/{invitation_id}/resend |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
invitation_id | str | yes | Invitation UUID from the route path |
payload | {"locale"?: str | null} | null | yes |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
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}] | yes | |
email | str | yes | |
id | str | yes | |
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} | yes | |
status | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.invitations.update
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | PATCH /v1/public/accounts/{account_id}/auth/invitations/{invitation_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
invitation_id | str | yes | Invitation UUID from the route path |
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}] | yes | |
note | str | null | no |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
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}] | yes | |
email | str | yes | |
id | str | yes | |
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} | yes | |
status | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.login
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | None | Auth required | no |
| Execution mode | sync |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
identifier | str | no | |
email | str | no | |
username | str | no | |
password | str | no | |
service_account_token | str | no |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
authenticated | bool | yes | |
principal_type | str | yes | |
user_id | str | no | |
service_account_id | str | no | |
email | str | no | |
username | str | no | |
expires_at | str | yes |
A2A example
A2A example
MCP example
MCP example
auth.logout
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | None | Auth required | no |
| Execution mode | sync |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
logged_out | bool | yes |
A2A example
A2A example
MCP example
MCP example
auth.role_assignments.create
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/role-assignments |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
resource_id | str | yes | Assignment scope resource identifier |
resource_type | "client" | "account" | "workspace" | "domain" | "dns_record" | "mailbox" | "redirect" | "forwarding" | "credential" | "tenant" | "route" | "proxy" | yes | Assignment scope resource type |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | yes | Code-defined role key |
subject_id | str | yes | User, group, or service account identifier |
subject_type | "user" | "group" | "service_account" | yes | Role assignment subject type: user, group, or service_account |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
expanded_capability_keys | [str] | yes | |
id | str | yes | |
resource_id | str | yes | |
resource_type | str | yes | |
role_key | str | yes | |
subject_id | str | yes | |
subject_type | str | yes | |
created_at | str | null | no | |
revoked_at | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.role_assignments.delete
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/role-assignments/{assignment_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
assignment_id | str | yes | Role assignment UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
MCP example
MCP example
auth.role_assignments.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/role-assignments |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
include_revoked | bool | no | Include revoked grants or assignments |
role_key | "viewer" | "editor" | "domain_manager" | "manager" | "dns_manager" | "ip_manager" | "billing_viewer" | "billing_admin" | "credential_manager" | null | no | Filter by authorization role key |
subject_id | str | null | no | Filter by authorization subject ID |
subject_type | "user" | "group" | "service_account" | null | no | Filter by authorization subject type |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
expanded_capability_keys | [str] | yes | |
id | str | yes | |
resource_id | str | yes | |
resource_type | str | yes | |
role_key | str | yes | |
subject_id | str | yes | |
subject_type | str | yes | |
created_at | str | null | no | |
revoked_at | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.service_accounts.create
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/service-accounts |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
name | str | yes | Human-readable service account name |
expires_at | str | null | no | Optional UTC token expiry timestamp |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
created_at | str | yes | |
id | str | yes | |
name | str | yes | |
token | str | yes | Plaintext bearer token. Store it now; it is never returned again. |
token_last4 | str | yes | |
token_prefix | str | yes | |
token_public_id | str | yes | |
updated_at | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.service_accounts.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/service-accounts |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
include_revoked | bool | no | Include revoked service accounts |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
created_at | str | yes | |
id | str | yes | |
name | str | yes | |
token_last4 | str | yes | |
token_prefix | str | yes | |
token_public_id | str | yes | |
updated_at | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.service_accounts.revoke
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | DELETE /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id} |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
service_account_id | str | yes | Service account UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
result | {} | yes |
A2A example
A2A example
MCP example
MCP example
auth.service_accounts.rotate
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | POST /v1/public/accounts/{account_id}/auth/service-accounts/{service_account_id}/rotate |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
service_account_id | str | yes | Service account UUID from the route path |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | |
created_at | str | yes | |
id | str | yes | |
name | str | yes | |
token | str | yes | Plaintext bearer token. Store it now; it is never returned again. |
token_last4 | str | yes | |
token_prefix | str | yes | |
token_public_id | str | yes | |
updated_at | str | yes | |
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 |
A2A example
A2A example
MCP example
MCP example
auth.users.list
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | auth.manage | Auth required | yes |
| Execution mode | sync | Capability | auth.manage |
| Resource type | account | Resource ID field | account_id |
| Public API route | GET /v1/public/accounts/{account_id}/auth/users |
Arguments
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
account_id | str | yes | Account UUID |
limit | int | no | Maximum number of users to return |
search | str | null | no | Optional user search string |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
id | str | yes | |
email | str | null | no | |
first_name | str | null | no | |
last_name | str | null | no | |
username | str | null | no |
A2A example
A2A example
MCP example
MCP example
auth.whoami
| Property | Value | Property | Value |
|---|---|---|---|
| Requires permission | None | Auth required | no |
| Execution mode | sync |
Returns
Returns
| Field | Type | Required | Description |
|---|---|---|---|
authenticated | bool | yes | |
user_id | str | no | |
email | str | no | |
username | str | no | |
expires_at | str | yes |
A2A example
A2A example
MCP example
MCP example