# Role

**Type**: `object`

## Properties

- name: builtin (optional)
  type: boolean
  description: Whether this is a built-in role

- name: createdAt (optional)
  type: string
  description: When the role was created (null for system roles)

- name: createdBy (optional)
  type: string
  description: Who created the role (null for system roles)

- name: description (required)
  type: string
  description: Description of the role

- name: effect (optional)
  type: string
  description: The effect of this role's permissions: 'allow' or 'deny'. Defaults to 'allow' for standard roles.

- name: id (required)
  type: string
  description: The id of the role.

- name: name (required)
  type: string
  description: The user-facing name of the role.

- name: permissionIds (required)
  type: array of string
  description: Permission IDs assigned to this role (empty for system roles)