Skip to content
On this page

Role


A role API resource represents an assignable label for users that provides a configured group of permissions.

Fields

NameTypeNullableDefaultDescription
idIntegerNoYesThe primary key of the resource
nameStringNoYesThe label of the resource
guard_nameStringNoYesThe authentication guard of the resource
defaultBooleanNoYesIs the role assigned on account verification?
colorStringYesYesThe hex representation of the color used to distinguish the resource
priorityIntegerYesYesThe weight assigned to the resource, where higher values correspond to higher priority
created_atDateNoNoThe date that the resource was created
updated_atDateNoNoThe date that the resource was last modified

Released under the MIT License.