Role
Returns the Role object for the given site.
- Syntax
- SITE.Role
- Returns
- roles.Role
Overview
The Role method on a Site object returns the Role object for the given site, derived from the role definition in your project configuration.
Methods
Use these methods on the Role object.
IsDefault- (
bool) Reports whether this is the default role.{{ site.Role.IsDefault }} → true Name- (
string) Returns the role name. This is the lowercased key from your project configuration.{{ site.Role.Name }} → guest
Last updated:
November 8, 2026
:
content: Remove categories from front matter (1cc1dd83a)
Improve this page