Skip to content

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 the role catalog including permission arrays as a finite snapshot. Requires an authenticated user. This intentionally includes permission arrays for clients that need to show a user’s assigned roles and their effects; use chatto.api.v1.RoleService for lightweight catalog rendering.

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; the assigned-user roster is empty unless the caller may assign roles.

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

Request one role.

FieldTypeDescription
namestringStable role name.

One role plus role-management metadata.

FieldTypeDescription
roleAdminRoleRequested role.
usersrepeated chatto.api.v1.UserExplicit users with this role. Empty unless the caller may assign roles.
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.

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.

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.

FieldTypeDescription
deletedboolTrue when the request completed.

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.