Skip to content
Chatto v0.5.0

Shared Types And Enums

Shared message and enum definitions used by the ConnectRPC service pages.

Metadata about a pending external identity flow. The provider subject is not exposed; clients only need user-facing provider/profile hints.

FieldTypeDescription
kindExternalIdentityFlowKindPending flow kind.
provider_idstringProvider ID that produced the identity.
provider_typestringProvider type that produced the identity.
provider_labelstringProvider label shown to the user.
verified_emailstringVerified email supplied by the provider, when available.
login_hintstringSuggested username derived from provider profile hints.
display_name_hintstringSuggested display name derived from provider profile hints.
bound_user_idstringUser ID this link flow is bound to. Empty for create flows.
redirect_pathstringInternal path the client should return to after confirmation.
choose_usernameoptional UsernameChoiceAvailabilityWhether the user can choose a username. When externally managed, the server assigns it and ignores client input. The login hint is not a reservation.
invitation_requiredboolA create flow must first supply an invitation code. Existing-account sign-in is unaffected.

One server in the Neighborhood of the called server.

FieldTypeDescription
originstringCanonical origin of the server.
profilechatto.api.v1.ServerPublicProfilePublic profile that the called server loaded. The welcome message is absent. The logo and banner URLs are server-relative paths of copies on the called server. Resolve them against the origin of the called server.
direct_neighborboolWhether the called server advertises this server as a Neighbor.
recommended_by_originsrepeated stringCanonical origins of other servers in the same response that mutually recommend this server. The list does not include the called server.

A product feature that an older frontend can describe without knowing its implementation. This is upgrade guidance, not permission, configuration, API negotiation, or a minimum version required to connect.

FieldTypeDescription
idstringStable feature identifier. Clients must accept previously unknown IDs.
namestringLocalised display name. Render as plain text, never HTML or Markdown.
descriptionstringLocalised explanation for users. Render as plain text.
introduced_versionstringFirst Chatto release with support for this feature in the server and bundled frontend. Third-party clients use the ID with their own support policy instead.

Offset-based page metadata returned by list RPCs.

FieldTypeDescription
total_countint64Total matching item count before pagination.
has_moreboolTrue when another page exists after this response.

Offset-based page request for list RPCs whose result order is stable enough for simple list browsing. Pages are live reads, not a fixed snapshot. Changes between requests can shift offsets.

FieldTypeDescription
limitint32Maximum number of items to request. Each RPC defines its default and effective maximum. Valid values above that maximum are capped. This shared shape rejects values above 500 or below zero. Zero uses the RPC default.
offsetint32Zero-based number of matching items to skip.

Public role metadata used for rendering role mentions, labels, and catalogs.

FieldTypeDescription
namestringStable role name used in permission and assignment records.
display_namestringDisplay name shown in user-facing role UIs.
descriptionstringOptional role description.
is_systemboolWhether this is a built-in role.
positionint32Display/order position.
pingableboolWhether messages may notify users assigned to this role.

Saved choice visible only to the authenticated account itself.

FieldTypeDescription
statusPresenceStatusSaved choice, independent of liveness. OFFLINE means “Appear Offline”; DO_NOT_DISTURB suppresses alerts even while disconnected.
revisionstringOpaque revision required when replacing this choice.

Custom status shown on a user profile, separate from presence.

FieldTypeDescription
emojistringShort emoji marker displayed with the status.
textstringUser-written status text.
expires_atgoogle.protobuf.TimestampOptional time after which clients should stop showing the status.

Public metadata for a bot account. Presence on User identifies a bot. Credentials and management-only details belong to the managed Bot resource.

FieldTypeDescription
owner_user_idstringHuman account that owns this bot; this identity does not grant management access.

Public user fields.

FieldTypeDescription
idstringStable user ID.
loginstringLogin name.
display_namestringDisplay name, when set.
deletedboolTrue when the user account has been deleted.
avatar_urloptional stringAvatar image URL, when available.
presence_statusPresenceStatusCurrent live presence status.
custom_statusCustomUserStatusCustom profile status, when set.
biooptional stringShort Markdown biography shown on the user’s profile, when set.
timezoneoptional stringIANA time zone the user chose to share on their profile (for example “Europe/Berlin”). Absent means the user has not enabled time-zone sharing or has no stored time zone.
botBotInfoPresent for a bot identity; absent for humans and deleted-account references.
deactivatedboolTrue while the account cannot use this server. Data is retained and access can be restored.

Effective decision for one capability key.

Built-in keys currently include:

  • admin.view
  • dm.start
  • admin.view-users
  • user.manage-accounts
  • user.manage-invites
  • role.assign
  • role.view
  • role.manage
  • admin.view-system
  • admin.view-audit
  • user.manage-permissions

Clients should ignore unknown keys so servers can add capabilities over time.

FieldTypeDescription
capabilitystringStable capability key, such as “admin.view” or “dm.start”.
grantedboolWhether the capability is currently available.

A permission currently allowed at a scope. Membership and action-specific requirements still apply. This is effective authority, not a stored grant.

FieldTypeDescription
permissionstringStable permission identifier.
scopeEffectivePermissionScopeScope where the permission is allowed.
covers_descendantsboolTrue when every applicable child scope also allows this permission. Hidden rooms participate in this check without revealing their identities. False means clients must not describe this grant as covering all children.

Scope metadata visible to the caller.

FieldTypeDescription
kindEffectivePermissionScopeKindScope tier.
idstringRoom or group ID; empty for server and DM scopes.
namestringCurrent room or group name; empty for server and DM scopes.
parent_group_idstringParent group ID for a channel room; empty for other scopes.

Effective decision for one permission key.

FieldTypeDescription
permissionstringStable permission key, such as “server.manage”.
grantedboolWhether the permission is currently granted.

An invitation visible only to its sender and recipient.

FieldTypeDescription
idstringNo field description provided.
room_idstringNo field description provided.
sender_idstringNo field description provided.
recipient_idstringNo field description provided.
created_atgoogle.protobuf.TimestampNo field description provided.
expires_atgoogle.protobuf.TimestampNo field description provided.
statusRoomInvitationStatusNo field description provided.
can_acceptboolTrue only for the recipient while current room and sender rules permit acceptance.

Image transform parameters for generated image URLs.

FieldTypeDescription
widthint32Target image width in pixels.
heightint32Target image height in pixels.
fitImageFitModeImage crop/fit behavior.

Browser-supplied image upload payload.

FieldTypeDescription
imagebytesRaw image bytes.
filenamestringOriginal browser filename, for diagnostics and future compatibility.
content_typestringBrowser-provided content type, for diagnostics and future compatibility.

Public login/provider metadata shared by discovery and account-linking APIs.

FieldTypeDescription
idstringStable configured provider ID.
typestringProvider type, such as “password”, “oidc”, “github”, or “discord”.
labelstringHuman-readable provider label.
login_urlstringURL that starts login for this provider.
issuer_urloptional stringOIDC issuer URL. Absent for providers that do not use OpenID Connect. Clients can compare this value with their own trusted issuer selection; the server does not select the client’s identity provider.
auto_provisionoptional boolWhether an unlinked identity may create a new account through this provider.

Link preview metadata used by message composers and room timeline events.

Clients should treat optional metadata as unavailable when absent. Message creation accepts only the preview_token returned by FetchLinkPreview, not client-provided metadata fields.

FieldTypeDescription
urlstringPreviewed URL.
titleoptional stringPage or embed title.
descriptionoptional stringPage or embed description.
image_urloptional stringPreview image URL, when available.
image_asset_idoptional stringExisting server asset ID for the preview image, when cached or stored with the message.
site_nameoptional stringSite name, when known.
embed_typeoptional stringEmbed provider or type, when recognized.
embed_idoptional stringProvider-specific embed ID, when recognized.
social_postSocialPostPreviewStructured, provider-neutral social-post data for native rendering.

Author shown on a social-post preview.

FieldTypeDescription
display_namestringAuthor display name.
handlestringProvider-native handle without a leading at-sign when applicable.
avatar_urloptional stringLocally served author avatar URL, when available.
avatar_asset_idoptional stringLocally stored author avatar asset ID, when available.

Website card embedded in a social post.

FieldTypeDescription
urlstringDestination URL.
titleoptional stringCard title, when available.
descriptionoptional stringCard description, when available.
image_urloptional stringLocally served card image URL, when available.
image_asset_idoptional stringLocally stored card image asset ID, when available.

One image attached directly to a social post.

FieldTypeDescription
urlstringLocally served image URL.
asset_idstringLocally stored image asset ID.
altoptional stringAuthor-provided alternative text.
widthoptional uint32Source aspect-ratio width, when known.
heightoptional uint32Source aspect-ratio height, when known.

Bounded, provider-neutral social-post data used for native preview cards.

FieldTypeDescription
providerstringStable lowercase provider identifier, such as “bluesky”.
authorSocialPostAuthorAuthor shown on the post.
textstringPlain-text post body.
published_atgoogle.protobuf.TimestampPost publication time.
imagesrepeated SocialPostImageImages attached directly to the post, in display order.
external_linkSocialPostExternalLinkWebsite card embedded in the post, when present.
content_warningoptional stringProvider-supplied content warning, when present.
urlstringCanonical URL for this post. Always set for quoted posts; the outer post may also use LinkPreview.url.
quoted_postSocialPostPreviewPost quoted by this post, when present. Quotes inside this snapshot are omitted so preview size and rendering depth remain bounded.

Renderable message data.

The same shape is used for top-level room messages, thread replies, and thread echo entries. Thread-related fields let clients render reply counts, thread participants, and follow state without additional per-message requests.

FieldTypeDescription
idstringStable message event ID.
room_idstringRoom containing the message.
created_atgoogle.protobuf.TimestampTime when the message was created.
actor_idstringUser ID of the message actor.
bodyoptional stringMessage body text, when available. A present empty string is distinct from an absent body.
attachmentsrepeated MessageAttachmentAttachments sent with the message.
link_previewLinkPreviewLink preview extracted for the message, when available.
updated_atgoogle.protobuf.TimestampTime when the message was last edited.
in_reply_tostringEvent ID this message directly replies to, when this is a reply.
thread_root_event_idstringEvent ID of the root message for the thread this message belongs to.
echo_of_event_idstringEvent ID this event echoes into the current view, when applicable. Echoes allow thread activity to appear in another timeline context.
echo_from_thread_root_event_idstringThread root ID of the echoed event, when applicable.
channel_echo_event_idstringChannel timeline event ID for a thread echo, when applicable.
reactionsrepeated MessageReactionReaction summaries for this message.
threadThreadSummaryAggregated thread state. Present only when a durable thread has been established for this root message, including an empty thread.
deleted_atgoogle.protobuf.TimestampTime when the message content was deleted through retraction or account crypto-shredding. Absent when unavailable body content is not a deletion.
pinnedboolTrue when this message’s canonical message is currently pinned in its channel room. Always false for direct-message rooms.
viewer_stateMessageViewerStateState resolved for the current viewer. Available even before a durable thread exists. Absent when viewer state has not been resolved.

Time-limited URL for an asset attached to a message.

Clients should expect these URLs to expire and refresh the asset through AssetService when a URL is no longer usable.

FieldTypeDescription
urlstringSigned asset URL.
expires_atgoogle.protobuf.TimestampTime when the signed URL expires.

Attachment metadata included with a message.

Image and video dimensions are best-effort metadata for layout. Asset URLs can be absent while processing is pending or when the source is unavailable.

FieldTypeDescription
idstringStable attachment ID.
filenamestringOriginal filename.
content_typestringMIME content type.
widthint32Image or video width in pixels, when known.
heightint32Image or video height in pixels, when known.
asset_urlMessageAssetUrlSigned URL for the original asset, when available.
thumbnail_asset_urlMessageAssetUrlSigned URL for a thumbnail image, when available. GIFs routed to video processing use the generated video thumbnail. The URL is absent when that thumbnail is unavailable.
video_processingMessageVideoProcessingVideo processing metadata for videos and animated GIFs.
descriptionoptional stringUser-provided description for accessibility and attachment details. Absent when the attachment has no description.

Aggregated reaction state for one emoji on one message.

This state is scoped to the current message and includes whether the current user has reacted with the same emoji.

FieldTypeDescription
emojistringEmoji or reaction key.
countint32Number of users who reacted with this emoji.
has_reactedboolTrue when the current user reacted with this emoji.
preview_user_idsrepeated stringPreview of up to five user IDs that reacted with this emoji.

HLS adaptive-streaming metadata for a processed video.

FieldTypeDescription
master_playlist_urlMessageAssetUrlSigned URL for the HLS master playlist. The URL authorises all playlists and segments in this video generation and expires with the attachment URL.

Processing metadata for a video attachment.

Clients can use this object to show upload/transcoding progress and decide whether to play a processed variant, show a thumbnail, or display a failure state.

FieldTypeDescription
statusMessageVideoProcessingStatusCurrent processing status.
duration_msint64Video duration in milliseconds.
widthint32Source video width in pixels.
heightint32Source video height in pixels.
source_availableboolTrue when the original source asset is currently available.
reason_codestringStable reason code for a failed or incomplete processing state.
thumbnail_asset_urlMessageAssetUrlSigned URL for the generated thumbnail, when available.
variantsrepeated MessageVideoVariantAvailable transcoded renditions.
hlsMessageVideoHLSAdaptive-streaming metadata. Absent on MP4-only historical results and servers that do not support HLS processing.

One transcoded video rendition.

FieldTypeDescription
qualitystringQuality label for the rendition.
widthint32Video width in pixels.
heightint32Video height in pixels.
sizeint64Rendition size in bytes.
asset_urlMessageAssetUrlSigned URL for the rendition.

Viewer-specific capabilities for one message, independent of whether its canonical thread has been established.

FieldTypeDescription
can_reply_in_threadoptional boolWhether the viewer can reply in this message’s canonical thread, including starting the first reply to a root. Includes read access, room policy, and broad or interaction-scoped posting authority. Absent when not resolved.
thread_slow_mode_next_post_atgoogle.protobuf.TimestampEarliest reply time in this message’s canonical thread, including when the root has no replies. Absent when disabled, expired, or bypassed.

Aggregated state for one message thread.

FieldTypeDescription
thread_root_event_idstringEvent ID of the root message for the thread.
reply_countint32Number of replies in this message’s thread.
last_reply_atgoogle.protobuf.TimestampCreation time of the most recent reply in this message’s thread.
participant_preview_user_idsrepeated stringPreview of up to twelve distinct thread authors, excluding erased users. The root author appears first, followed by current reply authors.
participant_countint32Total number of distinct root and current reply authors, excluding erased users.
viewer_stateThreadViewerStateState resolved for the current user.

Viewer-specific follow and reply-read state for one message thread.

FieldTypeDescription
is_followingoptional boolWhether the current user follows this message’s thread, when known.
has_unread_repliesoptional boolTrue when the thread contains replies after the current user’s read cursor, when known.
slow_mode_next_post_atgoogle.protobuf.TimestampEarliest time the viewer may reply. Absent when disabled, expired, or bypassed. The root message starts its author’s thread cooldown.

Room-scoped binary asset metadata and freshly signed URLs.

FieldTypeDescription
idstringStable asset ID.
filenamestringOriginal filename.
content_typestringMIME content type.
sizeint64Stored file size in bytes.
widthint32Media width when known.
heightint32Media height when known.
asset_urlMessageAssetUrlSigned URL for the original asset bytes.
thumbnail_asset_urlMessageAssetUrlSigned thumbnail image URL, when available. GIFs routed to video processing use the generated video thumbnail without image transform options. Absent when that thumbnail is unavailable.
video_processingMessageVideoProcessingVideo processing state for videos and animated GIFs.

One current room attachment and its message anchor.

FieldTypeDescription
attachmentAssetAttachment metadata and signed URLs.
message_event_idstringMessage event containing the attachment.
thread_root_event_idstringThread root event ID when the containing message is a thread reply.
created_atgoogle.protobuf.TimestampMessage creation timestamp.
descriptionoptional stringUser-provided description for this attachment. Absent when the attachment has no description.

Public user/member row used by user directory, room membership, and mention surfaces.

FieldTypeDescription
userUserPublic user fields.
rolesrepeated stringExplicit roles assigned to the user. Member listings include the virtual everyone role for parity with Chatto’s permission model.
created_atgoogle.protobuf.TimestampAccount creation time when known.

Current stored read position. Its event can later be retracted. The timestamp is absent if the event can no longer be resolved. This is not Badge attention.

FieldTypeDescription
last_read_event_idstringLast-read event ID, to locate the boundary in a timeline.
last_read_atgoogle.protobuf.TimestampCreation time of the last-read event, when available.

Current viewer’s stored room read state.

FieldTypeDescription
room_idstringRoom ID.
markerReadMarkerAbsent when no non-empty marker has been stored. Reading never initializes it.

Current viewer’s stored thread read state.

FieldTypeDescription
room_idstringRoom ID.
thread_root_event_idstringRoot message ID.
markerReadMarkerAbsent when no non-empty marker has been stored. Reading never advances it.

Room and root identity for one thread read state.

FieldTypeDescription
room_idstringRoom ID.
thread_root_event_idstringRoot message ID.

Payload for a message-posted timeline event.

FieldTypeDescription
messageMessageRenderable message created by this timeline event.

Payload for voice-call lifecycle timeline events.

FieldTypeDescription
room_idstringRoom containing the call.
call_idstringStable identifier for this call session.

One event in a room or thread timeline.

Clients should inspect the event oneof to choose the renderer for the event.

FieldTypeDescription
idstringStable event ID.
created_atgoogle.protobuf.TimestampTime when the event was created.
actor_idstringUser ID of the event actor.
event.message_postedRoomMessagePostedA message was posted.
event.room_createdRoomTimelineRoomEventThe room was created.
event.room_updatedRoomTimelineRoomEventThe room metadata was updated.
event.room_deletedRoomTimelineRoomEventThe room was deleted.
event.room_archivedRoomTimelineRoomEventThe room was archived.
event.room_unarchivedRoomTimelineRoomEventThe room was unarchived.
event.room_threading_mode_changedRoomTimelineThreadingModeChangedEventThe room’s Threading Mode changed.
event.user_joined_roomRoomTimelineRoomEventA user joined the room.
event.user_left_roomRoomTimelineRoomEventA user left the room.
event.call_startedRoomTimelineCallEventA voice call started in the room.
event.call_endedRoomTimelineCallEventThe voice call ended in the room.

Related entities included beside timeline/feed events.

Includes are reserved for hot paginated feed paths where many events may repeatedly reference the same render data. Other APIs should return resources directly and rely on BatchGet-style follow-up hydration instead of adding includes maps.

FieldTypeDescription
usersmap<string, User>Users keyed by user ID.

Cursor page of room or thread timeline events.

Use opaque start_cursor and end_cursor values with before/after requests to continue paging in either direction. Clients must treat cursor values as server-owned tokens and must not parse, construct, share between users, or reuse them for another room or thread. The server binds each cursor to the authenticated viewer and exact timeline resource. The has_older and has_newer flags tell clients whether another request can extend the current window.

FieldTypeDescription
eventsrepeated RoomTimelineEventEvents in chronological display order, oldest first.
start_cursorstringOpaque cursor for the first event in the page.
end_cursorstringOpaque cursor for the last event in the page.
has_olderboolTrue when older events are available before start_cursor.
has_newerboolTrue when newer events are available after end_cursor.
includesRoomTimelineIncludesHot-path related entities needed to render the page without per-event hydration.

Payload for room lifecycle and membership timeline events.

FieldTypeDescription
room_idstringRoom affected by the event.

Payload for a room Threading Mode change shown in the room timeline.

FieldTypeDescription
room_idstringRoom whose Threading Mode changed.
threading_modeRoomThreadingModeNewly configured Threading Mode.

One current pinned message in a channel room.

FieldTypeDescription
messageMessageCurrent renderable message. Retracted messages are omitted from pin lists.

Public room metadata returned by room commands.

FieldTypeDescription
idstringStable room ID.
kindRoomKindRoom kind.
namestringRoom name. Direct-message rooms may have an empty name because clients derive their display label from participants.
descriptionstringOptional room description.
archivedboolTrue when the room is archived and hidden from active room lists.
group_idstringRoom group ID for channel rooms. Empty for direct-message rooms.
universalboolTrue when a channel grants effective membership to eligible server members.
slow_mode_secondsuint32Minimum number of seconds a non-exempt member must wait between root message posts. Channel rooms only; zero means slow mode is disabled.
threading_modeRoomThreadingModeEffective threading policy for this room. Direct-message rooms always report ENABLED.
thread_slow_mode_secondsoptional uint32Per-user interval within each thread, including its root. Zero disables the interval. Absent on servers without independent thread slow mode.
created_atgoogle.protobuf.TimestampWhen the room was created. Absent when unavailable on an older server.
show_membership_eventsoptional boolWhether clients show room join/leave activity. Absence on older servers means true. Membership state and event delivery are not affected.

Current member-only notice in a channel room.

FieldTypeDescription
bodystringMarkdown source. Empty means the notice has been cleared.
versionstringOpaque write version. Send it with every mutation. Empty before first publish.
publication_idstringOpaque dismissal revision. Corrections preserve it; publish and republish replace it. Empty when there is no published notice.
published_atgoogle.protobuf.TimestampTime of publication or explicit republishing. Corrections preserve it. Absent when cleared or unavailable on an older server.

Lightweight room reference for cross-resource rows.

FieldTypeDescription
idstringStable room ID.
kindRoomKindRoom kind.
namestringRoom name. Direct-message rooms may have an empty name because clients derive their display label from participants.

Active channel room suspension with optional hydrated references.

FieldTypeDescription
idstringStable suspension event ID.
room_idstringChannel room ID.
roomRoomChannel room metadata, when the referenced room still exists.
user_idstringSuspended user ID.
userDirectoryMemberSuspended user profile, when the referenced user still exists.
moderator_idstringModerator user ID that created the suspension.
moderatorDirectoryMemberModerator profile, when the referenced user still exists.
reasonstringModerator-entered removal reason.
created_atgoogle.protobuf.TimestampTime the suspension was created.
expires_atgoogle.protobuf.TimestampOptional future time when the suspension expires. Absence means indefinite.

Ordered group of channel rooms and sidebar links.

FieldTypeDescription
idstringStable room group ID.
namestringDisplay name.
descriptionstringPublic group description, when set.
itemsrepeated RoomGroupItemMixed room/sidebar-link entries in sidebar order.
viewer_stateRoomGroupViewerStateState and permissions resolved for the current user.

One ordered item in a room group.

FieldTypeDescription
item.roomRoomWithViewerStateVisible room entry.
item.sidebar_linkSidebarLinkSidebar link entry.

Viewer-specific state for one room group.

FieldTypeDescription
permissionsrepeated PermissionGrantEffective group-scoped permission decisions after group state constraints.

Viewer-specific state and permission decisions for one room.

FieldTypeDescription
is_memberboolTrue when the current user is an effective room member.
has_unreadboolTrue when the room has neutral Badge attention for the current user. This state is independent of the user’s last-read message cursor.
permissionsrepeated PermissionGrantEffective room-scoped permission decisions after room state constraints.
slow_mode_next_post_atgoogle.protobuf.TimestampEarliest time the current user may create another root message. Absent when slow mode is disabled, expired, or bypassed by moderation permissions.
invitationRoomInvitationPending invitation for this viewer; does not grant access to room content.
can_rejoinoptional boolWhether current permissions and room state allow joining without an invitation, even if already a member. Absent on servers that do not report this decision.

Room metadata plus state and capabilities resolved for the authenticated viewer.

FieldTypeDescription
roomRoomPublic room metadata.
viewer_stateRoomViewerStateState and permission decisions resolved for the current user.
member_user_idsrepeated stringComplete participant user IDs for a DM, including participants whose accounts were deleted. Clients show those as deleted users. Empty for channel rooms.
has_message_historyoptional boolWhether this DM has an ordinary root message that the viewer can read. Absent for channel rooms.
last_message_atgoogle.protobuf.TimestampCreation time of the latest ordinary DM message that the viewer can read, including thread replies. Interaction-only access includes related threads. Edits and retractions do not change this value; historical imports are excluded. Absent for other room kinds or when no ordinary message is readable. Older servers can omit this field. Absence does not prove inactivity.
last_root_message_atgoogle.protobuf.TimestampCreation time of the latest ordinary DM root message, excluding thread replies. Uses the same visibility, import, and absence rules as last_message_at.

Sidebar link metadata for room group navigation.

FieldTypeDescription
idstringStable sidebar link ID.
labelstringDisplay label.
urlstringAbsolute http(s) URL or server-local path.

Login and registration options exposed before authentication.

FieldTypeDescription
direct_registration_enabledboolWhether users can create accounts through the public UI.
providersrepeated ProviderMetadataConfigured login providers.
authorize_urlstringURL for the legacy authorization flow, when enabled.
account_creation_policyAccountCreationPolicyAdmission policy for direct registration and provider auto-provisioning.
direct_login_enabledoptional boolWhether users can sign in directly with a username or email address and password. Absent on older servers, where clients should treat direct login as enabled.

Public server profile, identity, and branding fields.

FieldTypeDescription
namestringDisplay name of the Chatto server.
versionstringServer software version.
logo_urloptional stringOptional server logo URL.
banner_urloptional stringOptional server banner URL.
welcome_messageoptional stringOptional welcome message.
descriptionoptional stringOptional server description.

Public metadata for a configured external login provider.

FieldTypeDescription
link_urlstringURL that starts authenticated account linking for this provider. Clients should use StartExternalIdentityLink instead of navigating here directly.
linkedboolTrue when this provider is already linked to the authenticated user.
linked_identity_subject_hashstringLinked identity subject hash for this provider, when linked.
providerProviderMetadataShared provider metadata.

Linked provider identity metadata for the authenticated user’s settings UI.

FieldTypeDescription
provider_idstringProvider ID recorded when the identity was linked.
provider_typestringProvider type recorded when the identity was linked.
provider_labelstringCurrent or fallback provider label.
subject_hashstringStable one-way subject hash, useful only as a UI/list key.
disconnect_eligibilityDisconnectEligibilityDisconnect eligibility evaluated by ListExternalIdentities.

Self-service decisions for the current viewer. Each action owns its states.

FieldTypeDescription
change_usernameUsernameChangeAvailabilityChanging the username, excluding input-specific exceptions such as case-only edits.
change_passwordoptional PasswordChangeAvailabilitySetting an initial password or changing an existing password. Absent on older servers.
delete_accountoptional AccountDeletionAvailabilityStarting self-service account deletion. Absent on older servers.

Snapshot for changing a username. Missing means not reported. Commands still check policy and input, including case-only exceptions. ALLOWED enables it only when available_at is absent or has passed.

FieldTypeDescription
stateUsernameChangeAvailability.StateUnknown states remain disabled. Commands recheck authority and policy.
available_atgoogle.protobuf.TimestampIndependent earliest attempt time. Absent means no time restriction. Clients enable ALLOWED when this time passes; they should update a visible control once per second while waiting and stop its timer when it is removed or no longer waiting. This time never overrides a blocking or unknown state.

State of explicit privileged-mode activation for this authenticated session.

FieldTypeDescription
availableboolWhether the user has an elevation-required permission entitlement. This includes owner entitlement and explicit allows at any supported scope.
activeboolWhether elevated permissions are effective for this session now.
expires_atgoogle.protobuf.TimestampAbsolute activation deadline. Present only while privileged mode is active.

Effective server/channel permission decisions for the authenticated user.

FieldTypeDescription
permissionsrepeated PermissionGrantOne row per permission known to the server.

Non-permission server state for the authenticated user.

FieldTypeDescription
has_unread_roomsboolWhether any joined channel room has neutral Badge attention.

Server-level display settings for the authenticated user.

FieldTypeDescription
timezoneoptional stringOptional IANA timezone override. Absent means no choice has been recorded. Empty means the user explicitly chose the browser’s local timezone. Both use browser-local time; only absence permits automatic device reporting.
time_formatTimeFormatPreferred time format.
share_timezoneoptional boolWhether the stored time zone may appear on the user’s public profile. New servers always set this field. Its absence means the server does not support private time zones and may publish any stored time zone.

Permission-derived capabilities for the authenticated user.

FieldTypeDescription
grantsrepeated CapabilityGrantKeyed capability decisions for the authenticated user.
has_unread_followed_threadsboolWhether the user has unread followed threads.

Current authenticated user’s public profile plus self-only settings.

FieldTypeDescription
has_verified_emailboolWhether the account has at least one verified email address.
settingsUserSettingsCurrent user’s display settings.
viewer_can_delete_accountboolDeprecated. Whether the authenticated user may delete this account. New clients use actions.delete_account and fall back to this field only when that action is absent.
last_login_changegoogle.protobuf.TimestampLast time a login credential changed, when known.
profileUserPublic user fields for the authenticated user.
has_passwordboolWhether this account currently has a password sign-in credential.
actionsAccountActionsSelf-service account action snapshots. Absent on older servers.

One email address that the authenticated user has proved they control.

FieldTypeDescription
emailstringNormalized email address.
verified_atgoogle.protobuf.TimestampTime at which the address was verified.
primaryboolWhether account-directed email is sent to this address.

Current server-side state for one room-scoped attachment upload.

FieldTypeDescription
upload_idstringUpload session ID.
room_idstringRoom the resulting attachment asset will belong to.
statusAssetUploadStatusCurrent upload status.
committed_offsetint64Number of bytes committed so far.
sizeint64Total declared file size in bytes.
max_chunk_sizeint32Maximum accepted chunk size in bytes.
sha256stringSHA-256 digest of the complete file, lowercase hexadecimal.
expires_atgoogle.protobuf.TimestampUpload expiry. Clients should create a new upload after this time.
asset_idstringAsset ID after completion.

A managed bot account. Raw API keys are returned only when Chatto issues them.

FieldTypeDescription
userUserCanonical public bot identity.
owner_user_idstringStable human owner user ID.
created_atgoogle.protobuf.TimestampAccount creation time.
api_key_created_atgoogle.protobuf.TimestampLegacy time for the initial API key. Use api_keys for active credentials.
incoming_webhooksrepeated BotIncomingWebhookActive incoming webhook credentials, ordered by creation time.
api_keysrepeated BotApiKeyActive API keys, ordered by creation time.
last_login_changegoogle.protobuf.TimestampTime of the last username change that started the 30-day username cooldown. Absent when no cooldown was started. The bot, its owner, and bot managers cannot change the username again until the cooldown ends. A caller with user.manage-accounts can change it at any time.

Safe metadata for one active bot API key. The raw key is returned only when Chatto creates it.

FieldTypeDescription
idstringStable API-key credential ID.
namestringManager-defined name.
created_atgoogle.protobuf.TimestampTime the API key was created.
last_used_stateCredentialLastUsedStateAvailability of best-effort last-use telemetry.
last_used_atoptional google.protobuf.TimestampMost recent recorded successful authentication time.

Safe metadata for one active bot incoming webhook. The webhook URL is returned only when the credential is created.

FieldTypeDescription
idstringStable webhook credential ID.
namestringManager-defined name for the credential.
created_atgoogle.protobuf.TimestampTime the incoming webhook credential was created.
last_used_stateCredentialLastUsedStateAvailability of best-effort last-use telemetry.
last_used_atoptional google.protobuf.TimestampMost recent recorded successful authentication time.

Endpoint settings visible only to the bot owner or a caller with bot.manage. Authorization and signing credentials are write-only. The saved URL is visible.

FieldTypeDescription
idstringStable ID of this endpoint.
enabledboolWhether this configuration accepts new messages.
has_authorizationboolWhether an Authorization header is configured.
latest_failureBotWebhookFailureLatest retained failure for this endpoint. Absent when no failure is retained. Later successes do not clear it. Absence does not prove successful delivery.
urlstringSaved destination. May contain tool credentials; visible only to bot managers.
namestringHuman-readable name assigned at creation.
created_atgoogle.protobuf.TimestampTime this endpoint was created.

Safe summary of one recorded outbound webhook failure.

FieldTypeDescription
idstringStable delivery identifier shared by all retry attempts.
reasonstringSafe failure category. Never contains response bodies or credentials.
attemptsuint32Delivery attempts, up to the attempt limit. An attempt can fail before HTTP starts, so this is not an exact HTTP request count.
http_statusuint32Zero if no HTTP response was received.
completed_atgoogle.protobuf.TimestampTime the retained failure was recorded.
source_event_idstringSource message ID associated with this delivery.

One followed thread for the current user.

FieldTypeDescription
root_messageMessageRenderable root message, when the root is still visible.
roomRoomSummaryRoom containing the thread.
threadThreadSummaryAggregated thread state.
latest_replyMessageMost recent visible reply, when the thread has one.
direct_message_participant_user_idsrepeated stringUser IDs used to derive a direct-message conversation label. Empty for channel rooms.

Current follow state for one thread and viewer.

FieldTypeDescription
room_idstringRoom containing the thread.
thread_root_event_idstringEvent ID of the root message for the thread.
followingboolTrue when the current user follows the thread.

One current, authorized match. With thread grouping, each result represents one thread and message is its best match in the selected order.

FieldTypeDescription
messageMessageCurrent renderable message that matched the query.
relevance_scoredoubleSearch-provider relevance score. Higher values are more relevant for the same query. Clients may merge results from servers using compatible search implementations by this value.
thread_contextThreadSearchContextPresent only with THREAD grouping. The matching message can be a reply; the root and latest reply in this context need not match the query.

Current context for a grouped match. The viewer need not follow this thread. Search evidence stays on the containing MessageSearchResult.

FieldTypeDescription
root_messageMessageRenderable root message, when still visible.
roomRoomSummaryRoom containing this thread.
threadThreadSummaryCurrent thread metadata and viewer follow/read state.
latest_replyMessageMost recent visible reply, when present; it need not match the query.
direct_message_participant_user_idsrepeated stringConversation-label participants for direct messages; empty for channels.

Description supplied for one attachment in a new message.

FieldTypeDescription
asset_idstringRequired. Asset ID included in attachment_asset_ids on the same request.
descriptionstringPlain-text description with at most 1,000 Unicode characters. Trim outer whitespace before sending. Chatto also trims outer whitespace, preserves internal line breaks, and omits an empty result.

An @all message that included the viewer.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

A message that mentions the viewer directly.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

A direct message sent to the viewer.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

Deprecated compatibility payload. Chatto does not derive this signal.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

Activity in a thread followed by the viewer.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

An @here message that included the viewer.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

Delivery modes for Chatto’s finite built-in notification signal classes. Presence is significant: absent fields inherit in a stored policy.

FieldTypeDescription
direct_messagesoptional NotificationDeliveryModeNo field description provided.
direct_mentionsoptional NotificationDeliveryModeNo field description provided.
repliesoptional NotificationDeliveryModeNo field description provided.
role_mentionsoptional NotificationDeliveryModeNo field description provided.
here_mentionsoptional NotificationDeliveryModeNo field description provided.
all_mentionsoptional NotificationDeliveryModeNo field description provided.
followed_threadsoptional NotificationDeliveryModeNo field description provided.
followed_roomsoptional NotificationDeliveryModeDeprecated. Deprecated compatibility slot. Use room_messages at room scope.
reactionsoptional NotificationDeliveryModeNo field description provided.
room_messagesoptional NotificationDeliveryModeDelivery mode for root messages posted directly to joined channel rooms. Thread messages and direct messages use their own signal classes.
room_invitationsoptional NotificationDeliveryModeDelivery mode for invitations to join a channel room.

Exact visible message destination carried by a notification signal.

FieldTypeDescription
roomRoomSummaryRoom containing the source activity.
event_idstringExact source or reacted-to message event to reveal.
thread_root_event_idoptional stringThread root when the target is inside a thread.

One exact Notifications 2.0 source occurrence.

FieldTypeDescription
idstringStable occurrence ID.
created_atgoogle.protobuf.TimestampTime of the source activity.
actorUserUser who caused the source activity, when still visible.
signalNotificationSignalImmutable cause and destination represented by this occurrence.
unreadboolWhether this occurrence still contributes unread attention.
expires_atgoogle.protobuf.TimestampAbsolute expiry: the invitation deadline for room invitations, otherwise 90 days after source activity. Handled invitations are removed earlier.
attention_levelNotificationAttentionLevelSource-time visual importance of this occurrence.

Explicit and effective delivery modes for one notification policy scope.

FieldTypeDescription
overridesNotificationDeliveryModesExplicit modes at the requested scope. Missing fields mean Inherit.
effectiveNotificationDeliveryModesComplete modes after applying product, server, and room inheritance.

Explicit target for one notification policy. Clients must select exactly one scope. Direct-message rooms use room scope and never inherit from a room group.

FieldTypeDescription
scope.servergoogle.protobuf.EmptySelects the authenticated viewer’s server-wide policy.
scope.room_group_idstringSelects one existing room group’s policy.
scope.room_idstringSelects one room’s policy. Requires membership or a pending invitation.

Unread notification occurrences currently targeting one room.

FieldTypeDescription
room_idstringTarget room ID.
unread_countint32Number of unread occurrences targeting this room.
important_unread_countint32Unread occurrences in this room with Important attention.

Immutable, typed cause and destination of one notification. Clients must preserve unknown variants as generic dismissible rows and must not infer navigation semantics for them.

FieldTypeDescription
kind.direct_message_receivedDirectMessageReceivedNo field description provided.
kind.direct_mention_receivedDirectMentionReceivedNo field description provided.
kind.reply_receivedReplyReceivedNo field description provided.
kind.role_mention_receivedRoleMentionReceivedNo field description provided.
kind.here_mention_receivedHereMentionReceivedNo field description provided.
kind.all_mention_receivedAllMentionReceivedNo field description provided.
kind.followed_thread_activityFollowedThreadActivityNo field description provided.
kind.followed_room_activityFollowedRoomActivityDeprecated. No field description provided.
kind.reaction_receivedReactionReceivedNo field description provided.
kind.room_message_receivedRoomMessageReceivedNo field description provided.
kind.room_invitation_receivedRoomInvitationReceivedNo field description provided.

A reaction added to one of the viewer’s messages.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.
emojistringExact reaction supplied by the actor.

A reply to one of the viewer’s messages.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

A message mentioning a role held by the viewer.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.
role_namesrepeated stringSource-time role handles that selected the viewer. Multiple matching role mentions are consolidated into one occurrence for the source message.

An invitation to join a room. Its destination is the room, not a message. Attention ends when the invitation is handled or reaches the containing NotificationOccurrence’s expires_at deadline.

FieldTypeDescription
roomRoomSummaryNo field description provided.
invitation_idstringStable invitation identifier.

A root message posted directly to a channel room that the viewer belongs to.

FieldTypeDescription
messageNotificationMessageReferenceNo field description provided.

One policy together with the explicit scope that produced it.

FieldTypeDescription
scopeNotificationPolicyScopeExact policy scope.
policyNotificationPolicyExplicit and effective modes for the scope.

Authenticated server runtime settings used by clients.

FieldTypeDescription
push_notifications_enabledboolWhether Web Push notifications are fully configured.
vapid_public_keyoptional stringOptional VAPID public key for Web Push registration.
livekit_urloptional stringOptional LiveKit URL for voice and video calls.
video_processing_enabledboolWhether video processing is enabled.
max_upload_sizeint64Maximum upload size in bytes for all files, including GIFs and videos.
max_video_upload_sizeint64Deprecated. Deprecated alias of max_upload_size. Both fields have the same value.
message_edit_window_secondsint32Message edit window in seconds.

Current active call snapshot for one room.

FieldTypeDescription
roomRoomSummaryRoom containing the active call.
call_idstringActive call session ID.
participantsrepeated CallParticipantParticipants currently projected for this call.

User currently participating in a room call.

FieldTypeDescription
userUserParticipant user.
joined_atgoogle.protobuf.TimestampWhen the user joined this call.
call_idstringActive call session ID.

JetStream account limits and usage.

FieldTypeDescription
memoryint64Maximum memory storage in bytes. Values less than or equal to zero mean unlimited.
memory_usedint64Used memory storage in bytes.
storageint64Maximum file storage in bytes. Values less than or equal to zero mean unlimited.
storage_usedint64Used file storage in bytes.
streamsint32Maximum number of streams. Values less than or equal to zero mean unlimited.
streams_usedint32Current number of streams.
consumersint32Maximum number of consumers. Values less than or equal to zero mean unlimited.
consumers_usedint32Current number of consumers.

Current health of recoverable message-owned asset deletion.

FieldTypeDescription
healthAdminAssetCleanupHealthOperator-facing state derived from the shared durable consumer.
pending_countint64Deletion effects currently waiting for a successful retry.
oldest_pending_atgoogle.protobuf.TimestampDeprecated. Deprecated. Shared durable consumers do not expose this value.
pass_in_progressboolDeprecated. Deprecated. Shared durable consumers run continuously rather than in passes.
last_pass_atgoogle.protobuf.TimestampDeprecated. Deprecated. Shared durable consumers run continuously rather than in passes.
last_successful_pass_atgoogle.protobuf.TimestampDeprecated. Deprecated. Shared durable consumers run continuously rather than in passes.
updated_atgoogle.protobuf.TimestampDeprecated. Deprecated. Shared durable consumers do not publish a liveness heartbeat.
last_pass_failedboolDeprecated. Deprecated. Use health and pending_count instead.
last_inspected_sequencestringGlobal EVT sequence of the most recently delivered deletion fact.
latest_deletion_sequencestringCurrent latest global EVT sequence matching asset deletion facts.

Current NATS server connection metadata.

FieldTypeDescription
connectedboolWhether Chatto is currently connected to NATS.
server_idstringConnected NATS server ID.
server_namestringConnected NATS server name.
versionstringConnected NATS server version.
max_payloadint64Maximum payload accepted by the connected NATS server.
rttstringRound-trip latency to the connected NATS server.

Broker-derived health for one known durable worker queue.

FieldTypeDescription
keystringStable machine-readable worker key.
healthAdminDurableWorkerHealthCurrent availability and work state.
pending_countstringDeliveries not yet handed to a handler.
ack_pending_countstringDeliveries awaiting acknowledgement; this does not prove handler liveness.
waiting_countstringPull requests currently waiting for work.
redelivered_countstringRedelivered messages that remain unacknowledged.
last_delivered_sequencestringLatest EVT stream sequence delivered to this queue.
ack_floor_sequencestringHighest contiguous EVT stream sequence acknowledged by this queue.

LiveKit voice and video call setup as seen by the Chatto server that handled the request. The response never includes the API secret or the webhook signing secret.

Chatto calls the LiveKit server API once for each request to check reachability and credentials. Webhook times come from the memory of the Chatto server that handled the request. They reset when that server restarts, and other servers in a cluster keep their own times.

FieldTypeDescription
enabledboolWhether livekit.enabled is set.
configuredboolWhether LiveKit is enabled and the URL, API key, and API secret are all set.
urlstringConfigured LiveKit server URL that clients connect to.
api_keystringConfigured LiveKit API key. This is an identifier, not a secret.
separate_webhook_keyboolWhether webhooks use a signing key that differs from api_key.
webhook_urlstringURL that LiveKit must send webhooks to. Empty when the public server URL is not set.
connection_stateAdminLiveKitConnectionStateResult of the LiveKit server API check.
connection_errorstringError detail when the check fails. Never contains secrets.
insecure_urlboolTrue when url uses unencrypted ws:// or http:// and the public server URL host is not a loopback address or a .localhost name.
last_webhook_atgoogle.protobuf.TimestampTime of the last webhook with a valid signature that this server received.
last_rejected_webhook_atgoogle.protobuf.TimestampTime of the last webhook that this server rejected because of an invalid signature.

JetStream consumer state.

FieldTypeDescription
streamstringStream that owns the consumer.
namestringConsumer name.
durablestringDurable name, when the consumer is durable.
filter_subjectstringSingle filter subject, when configured.
filter_subjectsrepeated stringMultiple filter subjects, when configured.
ack_policystringNATS acknowledgement policy.
pull_basedboolWhether this is a pull consumer.
push_boundboolWhether this push consumer has an active subscription.
pendingint64Pending messages for this consumer.
ack_pendingint32Messages waiting for acknowledgement.
redeliveredint32Redelivered message count.
waitingint32Pull requests waiting for messages.
delivered_consumer_sequencestringDelivered consumer sequence.
delivered_stream_sequencestringDelivered stream sequence.
ack_floor_consumer_sequencestringAcknowledgement floor consumer sequence.
ack_floor_stream_sequencestringAcknowledgement floor stream sequence.

JetStream stream and consumer diagnostics.

FieldTypeDescription
total_messagesint64Total messages stored across all streams.
total_bytesint64Total bytes stored across all streams.
total_consumer_pendingint64Total pending messages across all consumers.
total_ack_pendingint32Total messages currently waiting for acknowledgement.
streamsrepeated AdminNatsStreamInfoStreams sorted by name.
consumersrepeated AdminNatsConsumerInfoConsumers sorted by stream and name.

JetStream stream state.

FieldTypeDescription
namestringStream name.
descriptionstringStream description.
subjectsrepeated stringSubjects stored in the stream.
storagestringStorage backend name.
messagesint64Number of messages in the stream.
bytesint64Number of bytes in the stream.
first_sequencestringFirst stream sequence.
last_sequencestringLast stream sequence.
consumer_countint32Number of stream consumers.
replicasint32Configured stream replica count.
cluster_leaderstringCurrent cluster leader, when reported by NATS.

Projection-specific diagnostic metric.

FieldTypeDescription
namestringMetric name.
valueint64Metric value.
bytesint64Estimated memory represented by this metric in bytes.

Event-sourced projection health and memory estimates.

FieldTypeDescription
keystringStable projection key.
namestringDisplay name.
subjectsrepeated stringEVT subjects consumed by this projection.
startedboolWhether the projection projector is running.
startup_duration_secondsoptional doubleStartup duration in seconds, set after startup completes.
last_applied_sequencestringLast event sequence applied by the projection.
matching_stream_sequencestringTarget sequence among the projection’s matching subjects.
stream_last_sequencestringCurrent last sequence of the EVT stream.
lagint64Matching-subject lag between target and applied sequence.
failedboolWhether the projection failed.
failed_sequencestringSequence that failed, when failed is true.
failurestringFailure message, when failed is true.
entry_countint64Estimated number of entries held by the projection.
estimated_bytesint64Estimated memory used by the projection in bytes.
average_entry_bytesint64Estimated average memory per entry in bytes.
metricsrepeated AdminProjectionMetricProjection-specific diagnostic metrics.

Aggregate Chatto object counts.

FieldTypeDescription
user_countint32Registered user count.
channel_room_countint32Channel room count.
dm_room_countint32Direct-message room count.

Broker and application diagnostics shown on the server admin system page.

FieldTypeDescription
connectionAdminConnectionInfoCurrent NATS server connection metadata.
accountAdminAccountInfoJetStream account limits and usage.
natsAdminNatsStatsJetStream stream and consumer diagnostics.
statsAdminServerStatsAggregate Chatto object counts.

One durable EVT entry decoded for operator inspection.

FieldTypeDescription
sequencestringEVT stream sequence.
subjectstringNATS subject.
aggregate_typestringAggregate type parsed from the subject.
aggregate_idstringAggregate ID parsed from the subject.
event_typestringEvent oneof payload type, or decode-error when decoding failed.
event_idstringDurable event ID.
actor_idstringActor user ID stored on the event.
created_atgoogle.protobuf.TimestampEvent creation timestamp.
payload_jsonstringPretty-printed, sanitized JSON representation of the event payload. Password verifiers are omitted.

Filter for owner/auditor event-log inspection.

FieldTypeDescription
event_typestringEvent oneof payload type, such as MessagePostedEvent.
actor_idstringActor user ID.
created_at_fromgoogle.protobuf.TimestampInclusive lower creation timestamp bound.
created_at_togoogle.protobuf.TimestampInclusive upper creation timestamp bound.

Permission to create one account on an invite-only server. Anyone who holds the code can use it; it is not bound to an email address or recipient.

FieldTypeDescription
idstringNo field description provided.
codestringRecoverable capability, visible to its creator with user.invite or to invitation managers. Never log it.
created_bystringNo field description provided.
created_atgoogle.protobuf.TimestampNo field description provided.
expires_atgoogle.protobuf.TimestampAbsent means no expiry. Revocation and successful account creation still invalidate the code.
statusInvitationCodeStatusNo field description provided.
revoked_atgoogle.protobuf.TimestampNo field description provided.
notestringOptional creation-time note for the creator and invitation managers. Empty means no note. This does not restrict who can redeem the code.

Role metadata plus optional administrative totals. Permission decisions are read through AdminPermissionService. Clients that used permissions or permission_denials must migrate to GetRolePermissionMatrix or ListRolePermissionDecisions. These reads require role.manage.

FieldTypeDescription
rolechatto.api.v1.RolePublic role metadata shared with ordinary role catalog reads.
member_countoptional uint64Active human members, including implicit membership for everyone. Reported by ListRoles only, for callers with role.manage or role.assign.
permission_grant_countoptional uint64Explicit permission grants across all scopes; excludes virtual owner access. Reported by ListRoles only, for callers with role.manage or role.assign.
permission_denial_countoptional uint64Explicit permission denials across all scopes. Reported by ListRoles only, for callers with role.manage or role.assign.

User row returned by server-admin member management reads.

The embedded user record carries public identity fields; remaining fields are admin/member metadata with visibility controlled by the service.

FieldTypeDescription
rolesrepeated stringExplicit role assignments. The implicit everyone role is omitted.
created_atgoogle.protobuf.TimestampAccount creation time, when known.
has_verified_emailboolWhether the caller may see that the user has a verified email and one exists.
verified_emailsrepeated stringVerified email addresses visible to the caller.
viewer_can_delete_accountboolWhether the caller may delete this account.
last_login_changegoogle.protobuf.TimestampStart of the current username-change cooldown, when visible and known.
userchatto.api.v1.UserPublic identity fields for this user.
primary_verified_emailoptional stringSelected primary verified email visible to the caller. Absence can mean that no primary email exists or that the field is not visible.
deactivatedboolDeactivated accounts retain their data but cannot use the server.
viewer_can_change_deactivationoptional boolWhether the caller may deactivate or reactivate this account. Absent on servers that do not support account deactivation.

Explicit role assignments and current assignment limits for one human user. This resource contains no account details. The implicit everyone role is omitted from all lists. List order is not significant. Limits are advisory: commands check current authority again. Read this resource again after an assignment, revocation, or permission change.

FieldTypeDescription
user_idstringTarget stable user ID.
role_namesrepeated stringRoles explicitly assigned to the target.
assignable_role_namesrepeated stringRoles within the caller’s current grant authority.
revocable_role_namesrepeated stringRoles within the caller’s current revoke authority for this target, including self-protection and configured-owner restrictions. A listed role need not currently be assigned.

An OAuth client that completed at least one successful user authorization.

FieldTypeDescription
client_idstringStable client identifier: a CIMD URL or built-in application URI.
client_namestringDisplay name from validated client metadata.
client_originstringPrivacy-safe canonical origin derived from validated client metadata.
sourceOauthClientSourceHow the client identity was established.
policyOauthClientPolicyCurrent server-administrator policy for the client.
first_authorization_atgoogle.protobuf.TimestampWhen this server first completed an authorization for the client.
last_authorization_atgoogle.protobuf.TimestampWhen this server most recently completed an authorization for the client.
redirect_originsrepeated stringCanonical web origins or native callback schemes seen during authorization.
authorized_user_countuint32Number of distinct users who have authorized this client.

Stored permission decision returned after a write.

FieldTypeDescription
permissionstringPermission identifier.
scopePermissionScopeServer, direct-message, group, or room scope for this decision.
decisionPermissionDecisionStored decision after the write. NONE means no explicit decision remains.

Full decision trace for one permission and target user.

FieldTypeDescription
permissionstringPermission identifier.
statePermissionDecisionOverall decision after resolving named subjects and the everyone baseline.
decided_atPermissionDecisionLevelLevel of the winning decision, when state is not NONE.
decided_by_rolestringRole name, user ID, or policy marker that produced the winning decision.
tracerepeated PermissionTraceEntryOrdered decision trace. The first entry is the winning decision.
included_by_permissionstringPermission whose effective allow includes this permission. Empty when the permission was resolved directly.

Matrix cell for one permission and scope.

FieldTypeDescription
permissionstringPermission identifier.
scope_idstringScope ID matching PermissionMatrixScope.id.
overridePermissionDecisionExplicit decision at this scope.
effectivePermissionDecisionEffective decision at this scope.
allow_permittedoptional boolWhether an explicit allow may currently be stored for this target. Absent when no additional delegation ceiling applies.

Matrix column scope.

FieldTypeDescription
idstringStable scope ID for the server, direct messages, a group, or a room.
labelstringHuman-readable label.
kindPermissionScopeKindScope tier.
parent_group_idstringParent group ID for room scopes.

Permission scope reference.

FieldTypeDescription
kindPermissionScopeKindScope tier.
idstringScope ID for group or room scope. Empty for server or direct-message scope.

One explicit decision encountered while explaining a permission.

FieldTypeDescription
levelPermissionDecisionLevelLevel at which this decision was observed.
role_namestringRole name, user ID, or policy marker that produced the decision.
decisionPermissionDecisionDecision observed at this trace step.
appliedboolWhether this entry is the winning decision.

Complete permission matrix for one role at the matching scopes.

FieldTypeDescription
role_namestringRole name.
applicable_permissionsrepeated stringPermissions rendered as rows.
scopesrepeated PermissionMatrixScopeScopes rendered as columns.
cellsrepeated PermissionMatrixCellSparse matrix cells.

One resource-oriented permission decision at a concrete scope.

This is the row-oriented counterpart to PermissionMatrixCell. Prefer this shape when building integrations that do not need matrix column joins.

FieldTypeDescription
permissionstringPermission identifier.
scopePermissionScopeServer, direct-message, group, or room scope for this decision.
overridePermissionDecisionExplicit decision stored at this scope.
effectivePermissionDecisionEffective decision after inherited broader scopes are applied.

Permission grants and denials at a single tier.

FieldTypeDescription
permissionsrepeated stringExplicitly granted permissions.
permission_denialsrepeated stringExplicitly denied permissions.

One role’s permission state at a single tier.

FieldTypeDescription
overrideTierPermissionsExplicit state at this tier.
inherited_allowsrepeated stringAllows inherited from broader tiers.
inherited_denialsrepeated stringDenials inherited from broader tiers.
rolechatto.api.v1.RolePublic role metadata.

Role permission matrix for one tier.

FieldTypeDescription
applicable_permissionsrepeated stringPermissions configurable at this tier.
rolesrepeated TierRoleRoles sorted by position.

Complete permission matrix for one user at the matching scopes.

FieldTypeDescription
user_idstringUser ID.
applicable_permissionsrepeated stringPermissions rendered as rows.
scopesrepeated PermissionMatrixScopeScopes rendered as columns.
cellsrepeated PermissionMatrixCellSparse matrix cells.

Ordered room group returned after admin layout mutations.

FieldTypeDescription
idstringStable room group ID.
namestringDisplay name.
descriptionstringPublic group description, when set.
itemsrepeated AdminRoomLayoutItemMixed room/sidebar-link entries in sidebar order.
can_create_roomboolWhether the viewer can create rooms in this group.

One ordered sidebar item in an admin room group layout.

FieldTypeDescription
item.roomchatto.api.v1.RoomChannel room entry.
item.sidebar_linkchatto.api.v1.SidebarLinkSidebar link entry.

One room or sidebar link reference in a move or order replacement.

FieldTypeDescription
item.room_idstringChannel room ID.
item.sidebar_link_idstringSidebar link ID.

One server advertised in the public Neighbor directory.

FieldTypeDescription
idstringStable opaque resource ID.
originstringCanonical HTTP or HTTPS server origin.
revisionstringOpaque revision required for update and delete requests.

Account creation settings. Admission applies to direct signup and new SSO accounts.

FieldTypeDescription
admissionchatto.api.v1.AccountCreationPolicyEffective policy. OPEN permits signup without an invitation.

Partial registration update. Unselected fields stay unchanged.

FieldTypeDescription
admissionoptional chatto.api.v1.AccountCreationPolicyUnspecified or a selected absent value resets admission to OPEN.

Runtime-editable server settings.

FieldTypeDescription
server_namestringServer name for page titles. Empty means the default is used.
descriptionstringShort server description for OG link-preview metadata.
motdstringMessage of the day for the authenticated header.
welcome_messagestringWelcome message shown on the login page.
registrationRegistrationSettingsSettings for new self-service accounts.

Mode of a pending external identity confirmation flow.

NameNumberDescription
EXTERNAL_IDENTITY_FLOW_KIND_UNSPECIFIED0The flow kind was not specified.
EXTERNAL_IDENTITY_FLOW_KIND_CREATE_ACCOUNT1Create a new passwordless account and link the provider identity.
EXTERNAL_IDENTITY_FLOW_KIND_LINK_ACCOUNT2Link the provider identity to the authenticated account.

State of choosing a username during account creation. Only ALLOWED enables choice; creation still checks policy and input. Unknown states remain disabled.

NameNumberDescription
USERNAME_CHOICE_AVAILABILITY_UNSPECIFIED0No decision is supplied. This does not grant permission.
USERNAME_CHOICE_AVAILABILITY_ALLOWED1The user can choose a username, subject to validation and uniqueness.
USERNAME_CHOICE_AVAILABILITY_PROVIDER_MANAGED2The provider supplies the username; the server resolves collisions.

Availability used for private choices and effective public presence.

Public Offline reveals neither connection liveness nor whether the account selected “Appear Offline”. A saved Online, Away, or Do Not Disturb choice becomes public Offline when no device refreshes liveness.

NameNumberDescription
PRESENCE_STATUS_UNSPECIFIED0No presence status was specified.
PRESENCE_STATUS_ONLINE1Online while at least one device refreshes liveness.
PRESENCE_STATUS_AWAY2Away while at least one device refreshes liveness.
PRESENCE_STATUS_DO_NOT_DISTURB3Do Not Disturb. A saved choice suppresses alerts even while disconnected.
PRESENCE_STATUS_OFFLINE4No public live presence. As a saved choice, suppresses presence and typing.

Scope of effective authority. Channel scopes never include direct messages.

NameNumberDescription
EFFECTIVE_PERMISSION_SCOPE_KIND_UNSPECIFIED0No scope supplied.
EFFECTIVE_PERMISSION_SCOPE_KIND_SERVER1Server authority or the default for channel rooms.
EFFECTIVE_PERMISSION_SCOPE_KIND_GROUP2A channel room group.
EFFECTIVE_PERMISSION_SCOPE_KIND_ROOM3One channel room.
EFFECTIVE_PERMISSION_SCOPE_KIND_DM4Direct-message authority; membership is always required.

Current lifecycle state. Expiry does not extend when the invitation is read.

NameNumberDescription
ROOM_INVITATION_STATUS_UNSPECIFIED0No value description provided.
ROOM_INVITATION_STATUS_PENDING1No value description provided.
ROOM_INVITATION_STATUS_ACCEPTED2No value description provided.
ROOM_INVITATION_STATUS_DECLINED3No value description provided.
ROOM_INVITATION_STATUS_EXPIRED4No value description provided.

Fit mode used when generating transformed image URLs.

NameNumberDescription
IMAGE_FIT_MODE_UNSPECIFIED0The fit mode was not specified.
IMAGE_FIT_MODE_CONTAIN1Preserve the whole source image within the requested bounds.
IMAGE_FIT_MODE_COVER2Fill the requested bounds, cropping when needed.

Policy governing thread creation and reply placement in a channel room. Direct-message rooms do not support threads and use UNSPECIFIED.

NameNumberDescription
ROOM_THREADING_MODE_UNSPECIFIED0No mode was supplied. CreateRoom treats this as ENABLED so older stored rooms and omitted request fields preserve Chatto’s default behavior.
ROOM_THREADING_MODE_REQUIRED1Every new root message establishes a thread, and replies to root messages must be posted in that root’s thread.
ROOM_THREADING_MODE_ENCOURAGED2Clients should steer replies into threads, but the server accepts both threaded and ordinary in-room replies.
ROOM_THREADING_MODE_ENABLED3Threads are available and clients may freely choose whether to use them.
ROOM_THREADING_MODE_DISABLED4New threads, thread replies, and channel echoes are rejected. Existing threads and echoes remain readable and ordinary in-room reply attribution remains available.

Processing state for a video attachment.

NameNumberDescription
MESSAGE_VIDEO_PROCESSING_STATUS_UNSPECIFIED0The processing status was not specified.
MESSAGE_VIDEO_PROCESSING_STATUS_PROCESSING1Video processing is still running.
MESSAGE_VIDEO_PROCESSING_STATUS_COMPLETED2Video processing completed successfully.
MESSAGE_VIDEO_PROCESSING_STATUS_FAILED3Video processing failed.

Kind of room represented by the public API.

NameNumberDescription
ROOM_KIND_UNSPECIFIED0The room kind was not specified.
ROOM_KIND_CHANNEL1A regular channel governed by server and room permissions.
ROOM_KIND_DM2A direct-message conversation between members.

Archive state to include in room directory responses.

NameNumberDescription
ROOM_ARCHIVE_FILTER_UNSPECIFIED0Include active rooms only.
ROOM_ARCHIVE_FILTER_ACTIVE1Include active rooms only.
ROOM_ARCHIVE_FILTER_ARCHIVED2Include archived rooms only.
ROOM_ARCHIVE_FILTER_ALL3Include both active and archived rooms.

Room kinds to include in directory responses.

NameNumberDescription
ROOM_DIRECTORY_SCOPE_UNSPECIFIED0Include visible channel rooms and the caller’s DM rooms.
ROOM_DIRECTORY_SCOPE_ALL1Include visible channel rooms and the caller’s DM rooms.
ROOM_DIRECTORY_SCOPE_CHANNELS2Include visible channel rooms only.
ROOM_DIRECTORY_SCOPE_DMS3Include the caller’s DM rooms only.

Policy controlling whether self-service account creation requires an invitation.

NameNumberDescription
ACCOUNT_CREATION_POLICY_UNSPECIFIED0Compatibility value used by older servers. Clients treat it as open.
ACCOUNT_CREATION_POLICY_OPEN1Self-service account creation does not require an invitation.
ACCOUNT_CREATION_POLICY_INVITE_ONLY2Every self-service account creation path requires a valid invitation.

State of disconnecting a linked identity. Only ALLOWED enables the action. UNSPECIFIED means not evaluated; older-server fallbacks may use account state. Unknown future states remain disabled. This does not replace fresh authentication or the mutation’s eligibility check.

NameNumberDescription
DISCONNECT_ELIGIBILITY_UNSPECIFIED0Eligibility was not evaluated, including responses from older servers.
DISCONNECT_ELIGIBILITY_ALLOWED1Another enabled sign-in method would remain.
DISCONNECT_ELIGIBILITY_LAST_ENABLED_SIGN_IN_METHOD2Disconnecting would leave no enabled sign-in method.
DISCONNECT_ELIGIBILITY_DISABLED_BY_OPERATOR3The operator disabled user-initiated unlinking for this provider.

State of self-service account deletion. Only ALLOWED enables the action; commands still check authority and authentication.

NameNumberDescription
ACCOUNT_DELETION_AVAILABILITY_UNSPECIFIED0No decision is supplied. This does not grant permission.
ACCOUNT_DELETION_AVAILABILITY_ALLOWED1The user can attempt to start account deletion.
ACCOUNT_DELETION_AVAILABILITY_PERMISSION_DENIED2The viewer lacks permission to delete this account.
ACCOUNT_DELETION_AVAILABILITY_UNSUPPORTED_ACCOUNT3This account type does not support self-service deletion.

State of setting or changing a password. Only ALLOWED enables the action; commands still validate passwords and authentication.

NameNumberDescription
PASSWORD_CHANGE_AVAILABILITY_UNSPECIFIED0No decision is supplied. This does not grant permission.
PASSWORD_CHANGE_AVAILABILITY_ALLOWED1The user can attempt to set or change a password.
PASSWORD_CHANGE_AVAILABILITY_DIRECT_LOGIN_DISABLED2The operator disabled direct login and password self-service.
PASSWORD_CHANGE_AVAILABILITY_UNSUPPORTED_ACCOUNT3This account type does not support password self-service.

State of username self-service, including its primary blocking condition.

NameNumberDescription
STATE_UNSPECIFIED0No decision is supplied. This does not grant permission.
STATE_ALLOWED1Policy permits a username change, subject to available_at.
STATE_PROVIDER_MANAGED2A linked provider manages the username.

User preference for rendering times in clients.

NameNumberDescription
TIME_FORMAT_UNSPECIFIED0No explicit preference was stored.
TIME_FORMAT_AUTO1Let the client choose based on locale and browser settings.
TIME_FORMAT_12_HOUR2Render times using a 12-hour clock.
TIME_FORMAT_24_HOUR3Render times using a 24-hour clock.

Upload lifecycle state for a room-scoped attachment upload.

NameNumberDescription
ASSET_UPLOAD_STATUS_UNSPECIFIED0The upload status was not specified.
ASSET_UPLOAD_STATUS_OPEN1The upload accepts more chunks.
ASSET_UPLOAD_STATUS_COMPLETED2The upload has been completed and produced an attachment asset.
ASSET_UPLOAD_STATUS_CANCELLED3The upload was cancelled or expired.

Availability of best-effort credential last-use telemetry.

NameNumberDescription
CREDENTIAL_LAST_USED_STATE_UNSPECIFIED0The server did not return a last-use state.
CREDENTIAL_LAST_USED_STATE_NO_USE_RECORDED1The server has no recorded use for the credential.
CREDENTIAL_LAST_USED_STATE_RECORDED2last_used_at contains the most recent recorded authentication time.
CREDENTIAL_LAST_USED_STATE_UNAVAILABLE3Last-use telemetry is temporarily unavailable.

Ordering for followed threads. Equal dates use a stable thread identity order.

NameNumberDescription
THREAD_ORDER_UNSPECIFIED0Use newest activity first.
THREAD_ORDER_ACTIVITY1Use newest activity first.
THREAD_ORDER_CREATED2Use newest root-message creation first. Unknown creation dates come last.

Selects threads by the author of their root message, not their replies.

NameNumberDescription
THREAD_ROOT_AUTHOR_FILTER_UNSPECIFIED0Include all root authors.
THREAD_ROOT_AUTHOR_FILTER_VIEWER1Include only roots authored by the authenticated viewer.
THREAD_ROOT_AUTHOR_FILTER_OTHERS2Include only roots authored by other users.

Determines the result type and pagination unit.

NameNumberDescription
MESSAGE_SEARCH_GROUP_BY_UNSPECIFIED0Return individual matching messages.
MESSAGE_SEARCH_GROUP_BY_THREAD1Return distinct thread rows. A root without replies is also a thread.

Ordering for message or grouped-thread search results.

NameNumberDescription
MESSAGE_SEARCH_ORDER_UNSPECIFIED0Use relevance order.
MESSAGE_SEARCH_ORDER_RELEVANCE1Highest message score first; grouped results use their best matching message.
MESSAGE_SEARCH_ORDER_NEWEST2Newest matching message first, also when results are grouped.
MESSAGE_SEARCH_ORDER_THREAD_ACTIVITY3Return threads with the most recent activity first. Requires thread grouping.
MESSAGE_SEARCH_ORDER_THREAD_CREATED4Newest root-message creation first, with unknown dates last. Requires thread grouping. Older servers can reject this order.

Candidate scope, intersected with the caller’s current access and query filters.

NameNumberDescription
MESSAGE_SEARCH_SCOPE_UNSPECIFIED0Search all accessible messages. This is the existing default.
MESSAGE_SEARCH_SCOPE_FOLLOWED_THREADS1Search roots and replies in followed threads, including direct messages.

Current availability of message search on this server.

NameNumberDescription
MESSAGE_SEARCH_STATE_UNSPECIFIED0The server did not report a meaningful state.
MESSAGE_SEARCH_STATE_DISABLED1Search is disabled by the server operator.
MESSAGE_SEARCH_STATE_STARTING2Search is enabled but its provider has not established index state yet.
MESSAGE_SEARCH_STATE_INDEXING3The provider is rebuilding or catching up and cannot answer queries yet.
MESSAGE_SEARCH_STATE_READY4Search is ready to answer queries.
MESSAGE_SEARCH_STATE_DEGRADED5Search can answer queries but has a known non-fatal limitation.
MESSAGE_SEARCH_STATE_UNAVAILABLE6Search is enabled but no provider can currently answer.

Visual importance of an unread notification. This is independent from whether the notification is eligible for sound or push delivery.

NameNumberDescription
NOTIFICATION_ATTENTION_LEVEL_UNSPECIFIED0No attention level was provided.
NOTIFICATION_ATTENTION_LEVEL_AMBIENT1Ambient activity appears with a neutral unread indicator.
NOTIFICATION_ATTENTION_LEVEL_IMPORTANT2Important activity appears with Chatto’s notification orange.

Delivery behavior for one notification signal class.

NameNumberDescription
NOTIFICATION_DELIVERY_MODE_UNSPECIFIED0No delivery mode was specified. This value is not a valid override.
NOTIFICATION_DELIVERY_MODE_OFF1Matching activity does not create user attention.
NOTIFICATION_DELIVERY_MODE_SILENT2Deprecated alias for NOTIFICATION_DELIVERY_MODE_IN_APP_NOTIFICATION.
NOTIFICATION_DELIVERY_MODE_IN_APP_NOTIFICATION2Matching activity creates an in-app notification but does not send push.
NOTIFICATION_DELIVERY_MODE_ALERT3Deprecated alias for NOTIFICATION_DELIVERY_MODE_PUSH_NOTIFICATION.
NOTIFICATION_DELIVERY_MODE_PUSH_NOTIFICATION3Matching activity creates an in-app notification and may send push.
NOTIFICATION_DELIVERY_MODE_UNREAD_BADGE4Matching activity adds a neutral unread indicator without creating a notification occurrence, playing a sound, or sending push.

Native companion publisher kind.

NameNumberDescription
CALL_MEDIA_PUBLISHER_KIND_UNSPECIFIED0The publisher kind was not specified.
CALL_MEDIA_PUBLISHER_KIND_GAME_SHARE1Native game-window video and application audio.

Operator-facing state for the shared durable asset cleanup queue.

NameNumberDescription
ADMIN_ASSET_CLEANUP_HEALTH_UNSPECIFIED0No value description provided.
ADMIN_ASSET_CLEANUP_HEALTH_INACTIVE1No value description provided.
ADMIN_ASSET_CLEANUP_HEALTH_INITIALIZING2No value description provided.
ADMIN_ASSET_CLEANUP_HEALTH_HEALTHY3No value description provided.
ADMIN_ASSET_CLEANUP_HEALTH_RETRYING4No value description provided.
ADMIN_ASSET_CLEANUP_HEALTH_STALLED5No value description provided.
ADMIN_ASSET_CLEANUP_HEALTH_UNAVAILABLE6Cleanup diagnostics could not be read; other system diagnostics remain valid.

Operator-facing state derived from a durable consumer.

NameNumberDescription
ADMIN_DURABLE_WORKER_HEALTH_UNSPECIFIED0No value description provided.
ADMIN_DURABLE_WORKER_HEALTH_INACTIVE1This optional worker is not required by current server configuration.
ADMIN_DURABLE_WORKER_HEALTH_HEALTHY2A worker is waiting and all known work is acknowledged.
ADMIN_DURABLE_WORKER_HEALTH_WORKING3A worker is available and unacknowledged work remains.
ADMIN_DURABLE_WORKER_HEALTH_UNCONFIRMED4An acknowledgement is pending, but broker state cannot prove whether a handler is active or the delivery is awaiting recovery after a crash.
ADMIN_DURABLE_WORKER_HEALTH_STALLED5The consumer exists but has neither a waiting pull nor an ack-pending delivery.
ADMIN_DURABLE_WORKER_HEALTH_UNAVAILABLE6The required consumer is unavailable.

Result of the LiveKit server API check.

NameNumberDescription
ADMIN_LIVE_KIT_CONNECTION_STATE_UNSPECIFIED0Unknown state.
ADMIN_LIVE_KIT_CONNECTION_STATE_NOT_CONFIGURED1LiveKit is not configured, so Chatto did not do the check.
ADMIN_LIVE_KIT_CONNECTION_STATE_OK2LiveKit accepted the API call with the configured key and secret.
ADMIN_LIVE_KIT_CONNECTION_STATE_UNREACHABLE3Chatto could not connect to the LiveKit server URL.
ADMIN_LIVE_KIT_CONNECTION_STATE_UNAUTHORIZED4LiveKit rejected the configured API key or secret.
ADMIN_LIVE_KIT_CONNECTION_STATE_ERROR5The server at the URL replied with an unexpected error.

Current state of a single-use registration code.

NameNumberDescription
INVITATION_CODE_STATUS_UNSPECIFIED0No value description provided.
INVITATION_CODE_STATUS_ACTIVE1No value description provided.
INVITATION_CODE_STATUS_EXPIRED2No value description provided.
INVITATION_CODE_STATUS_USED3No value description provided.
INVITATION_CODE_STATUS_REVOKED4No value description provided.

Administrator policy for a public OAuth client. Trusted is an informational blessing and never bypasses individual user consent.

NameNumberDescription
OAUTH_CLIENT_POLICY_UNSPECIFIED0No valid policy was supplied.
OAUTH_CLIENT_POLICY_DEFAULT1The client follows the normal open-client authorization policy.
OAUTH_CLIENT_POLICY_TRUSTED2Administrators have labelled the client as trusted without changing consent.
OAUTH_CLIENT_POLICY_BLOCKED3The client cannot authorize or use its existing OAuth access tokens.

How a public OAuth client establishes its identity with this server.

NameNumberDescription
OAUTH_CLIENT_SOURCE_UNSPECIFIED0The server does not recognize the source value.
OAUTH_CLIENT_SOURCE_CIMD1The client identifies itself with an HTTPS Client ID Metadata Document.
OAUTH_CLIENT_SOURCE_BUILT_IN2The client uses a registration built into this Chatto release.

Trinary permission decision used by permission matrices and write requests.

NameNumberDescription
PERMISSION_DECISION_UNSPECIFIED0Unspecified decision; rejected for writes.
PERMISSION_DECISION_ALLOW1Explicit allow.
PERMISSION_DECISION_DENY2Explicit deny.
PERMISSION_DECISION_NONE3No explicit decision; clears the permission state on writes.

Level at which a permission explanation found a decision.

NameNumberDescription
PERMISSION_DECISION_LEVEL_UNSPECIFIED0No decision level was reached.
PERMISSION_DECISION_LEVEL_SERVER1Server-level role or user decision.
PERMISSION_DECISION_LEVEL_GROUP2Room-group-level role or user decision.
PERMISSION_DECISION_LEVEL_ROOM3Room-level role or user decision.
PERMISSION_DECISION_LEVEL_DM4Direct-message-level role or user decision.

Scope tier for permission matrices and write requests.

NameNumberDescription
PERMISSION_SCOPE_KIND_UNSPECIFIED0Unspecified scope; treated as server scope where older clients omit it.
PERMISSION_SCOPE_KIND_SERVER1Server tier.
PERMISSION_SCOPE_KIND_GROUP2Room-group tier.
PERMISSION_SCOPE_KIND_ROOM3Room tier.
PERMISSION_SCOPE_KIND_DM4Server-wide direct-message tier.