pub struct GroupRole {Show 20 fields
pub group_type_id: i64,
pub grow_path_id: Option<i64>,
pub is_default: bool,
pub is_hidden: bool,
pub is_leader: Option<bool>,
pub name: String,
pub shorty: String,
pub sort_key: i64,
pub type: String,
pub id: i64,
pub name_translated: String,
pub can_read_chat: bool,
pub can_write_chat: bool,
pub counts_towards_seats: bool,
pub force_two_factor_auth: bool,
pub group_type_role_id: i64,
pub html_template_ids: Option<Vec<i64>>,
pub is_active: bool,
pub receive_qr_code: bool,
pub extra: Map<String, Value>,
}Expand description
A shared group-type role combined with its settings for one concrete group. id identifies this group’s role settings; groupTypeRoleId identifies the shared definition. growPathId is also group-specific. The inherited name, type and default/hidden flags describe the shared definition.
Fields§
§group_type_id: i64ID of the group type this role belongs to. Discover group types with GET /group/grouptypes.
grow_path_id: Option<i64>Growth-path association for this role in this group, or null when none is set. This is the group-specific value, not the value of the shared role definition.
is_default: boolWhether this is the default role for its group type. Setting this to true clears the default flag on the other roles of that type.
Whether this role is marked as hidden for displays that exclude hidden roles, such as leader listings. Hidden roles are still returned by this endpoint; this flag is not an access permission.
is_leader: Option<bool>Use type instead; this field is not used to create or update a role.
Legacy response field indicating whether type is leader. Use type instead; this field is not used to create or update a role.
name: StringStored name of the role. Use nameTranslated from the response for a localized display name.
shorty: StringAbbreviated label for the role, used in compact displays.
sort_key: i64Display order among roles. Lower values come first.
type: StringFunctional classification of the role. Multiple roles with different names can share the same classification.
Allowed values: leader, participant.
id: i64ID of the role settings record for this group. Use this ID in PATCH /groups/{groupId}/roles/{roleId}.
name_translated: StringLocalized display name, translated from the stored name when a translation exists.
can_read_chat: boolWhether members in this role are allowed to read the group chat.
can_write_chat: boolWhether members in this role are allowed to write in the group chat.
counts_towards_seats: boolWhether memberships in this role count towards the group’s participant capacity.
force_two_factor_auth: boolWhether members in this role are required to use two-factor authentication.
group_type_role_id: i64ID of the shared role definition from GET /group/roles. This differs from id, which identifies the settings for this group.
html_template_ids: Option<Vec<i64>>IDs of HTML templates available for membership documents in this role; null when no template list is stored.
is_active: boolWhether this role is enabled for use in this group. This is a role setting, separate from an individual person’s membership status.
receive_qr_code: boolWhether members in this role receive a QR code for group check-in.
extra: Map<String, Value>Fields not described by the spec, e.g. instance-specific DB fields.