Restriction

class Restriction[source]

The JSON representation of a Restriction.

id: str

The unique identifier for this restriction.

session_lockdown: RestrictionSetSessionLockdownWithEntryWindow | RestrictionNotSetSessionLockdown

Session lockdown settings, or not-set if disabled. When set, the entry_window it carries is always the global configured window.

exam_environment: RestrictionExamEnvironment

What the viewer must do before they can enter, derived from the attached exam environment provider’s capabilities so this field and the capability cannot drift. not-set when the exam is not proctored, and for an anonymous viewer, who is told nothing.

exam_environment_management: ExamEnvironmentManagement | None

What the management UI needs to configure the exam environment: the attached provider and the ones this tenant may attach, each described through its capabilities. Distinct from the student-facing exam_environment field. None — telling the viewer nothing — unless the tenant’s release flag is on and the viewer may manage exam environments.

password: RestrictionMixinSetPassword | RestrictionMixinNotSetPassword

Whether a password is set (tag: ‘set’) or not (tag: ‘not-set’).