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:
May 28, 2026
:
content: Replace h3 method sequences with description lists (c8e5b9fd2)
Improve this page