Role

Better Auth role definition

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • displayName
    Type: string
    required

    Human-readable name

  • id
    Type: stringFormat: uuid
    required
  • isSystem
    Type: boolean
    required

    Whether this is a system role (cannot be modified)

  • name
    Type: string
    required

    Role identifier (e.g., entity-admin, team-admin)

  • updatedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • deletedAt
    Type: stringFormat: date-time nullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • description
    Type: string
  • entityId
    Type: stringFormat: uuid nullable

    Entity scope (null for global roles)