Skip to content
Chatto v0.5.0

AdminRoleService

Chatto exposes this service below /api/connect.

Shared message and enum definitions are documented in Shared Types And Enums.

Provides authenticated role reads and administrative role definition changes.

Lists role metadata, optional totals, and viewer capabilities as a finite snapshot. Requires an authenticated user. Read permission decisions through AdminPermissionService; use chatto.api.v1.RoleService for public metadata.

POST /api/connect/chatto.admin.v1.AdminRoleService/ListRoles

Request the role catalog.

Finite role catalog snapshot plus viewer role-management capabilities.

FieldTypeDescription
rolesrepeated AdminRoleRoles sorted by position.
viewer_can_manage_rolesboolWhether the caller may create/update/delete role definitions.
viewer_can_assign_rolesboolWhether the caller may assign/revoke roles and view role rosters.

Gets one role plus admin detail metadata. Returns NOT_FOUND when the role does not exist. Requires an authenticated user.

POST /api/connect/chatto.admin.v1.AdminRoleService/GetRole

Request one role.

FieldTypeDescription
namestringStable role name.

One role plus role-management metadata.

FieldTypeDescription
roleAdminRoleRequested role.
viewer_can_manage_rolesboolWhether the caller may create/update/delete role definitions.
viewer_can_assign_rolesboolWhether the caller may assign/revoke roles and view role rosters.

Lists explicit role members. Requires role.assign, without requiring admin.view-users. Returns NOT_FOUND when the role does not exist.

POST /api/connect/chatto.admin.v1.AdminRoleService/ListMembers

Request a page of explicit role members.

FieldTypeDescription
namestringStable role name.
pagechatto.api.v1.PageRequestDefaults to 20 members; capped at 100. Offset counts explicit assignments.

Result: AdminRoleServiceListMembersResponse

Section titled “Result: AdminRoleServiceListMembersResponse”

Explicit members sorted by user ID. Each page is a live read; assignment changes between requests can shift offsets. The implicit everyone role has no explicit members. Revoked assignments are excluded.

FieldTypeDescription
membersrepeated chatto.api.v1.UserCanonical public user records for the selected assignments.
pagechatto.api.v1.PageInfoTotal explicit assignment count and whether another page exists.

Creates a custom role. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoleService/CreateRole

Request to create a role.

FieldTypeDescription
namestringStable role name.
display_namestringDisplay name shown in admin and mention UIs.
descriptionstringOptional role description.
pingableboolWhether messages may notify users assigned to this role.

Result of creating a role.

FieldTypeDescription
roleAdminRoleCreated role.

Updates role metadata. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoleService/UpdateRole

Request to update role metadata.

FieldTypeDescription
namestringStable role name.
display_nameoptional stringDisplay name shown in admin and mention UIs, when changing it.
descriptionoptional stringRole description, when changing it. Empty clears the description.
pingableoptional boolWhether messages may notify users assigned to this role, when changing it.
update_maskgoogle.protobuf.FieldMaskEditable fields to apply or reset: display_name, description, pingable. Omit to infer populated fields; * selects all editable fields. An explicit empty mask is invalid. Unselected values are ignored. Selected absent values reset the field to its default, subject to field validation.

Result of updating a role.

FieldTypeDescription
roleAdminRoleUpdated role.

Deletes a custom role. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoleService/DeleteRole

Request to delete a role.

FieldTypeDescription
namestringStable role name.

Result of deleting a role.

Replaces the custom role order. Requires role.manage.

POST /api/connect/chatto.admin.v1.AdminRoleService/ReorderRoles

Request to replace custom role order.

FieldTypeDescription
role_namesrepeated stringOrdered custom role names. The list must include every custom role exactly once; system roles keep fixed positions and must not be included.

Result of replacing custom role order.

FieldTypeDescription
rolesrepeated AdminRoleFull role catalog after reordering.