SessionEnforcementStateOutput

  • applicationId
    Type: string Format: uuid
    required
  • authority
    Type: string enum
    required
    values
    • LEGACY_BACKEND
    • PLATFORM
  • caliperSessionId
    Type: string
    required
  • lockout
    Type: object · ProctoringLockoutOutputnullable
    required

    Persisted proctoring lockout record with audit fields

    • dateCreated
      Type: string Format: date-time
      required

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

    • dateLastModified
      Type: string Format: date-time
      required

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

    • expiresAt
      Type: string Format: date-time
      required

      Computed server-side as startsAt + resolved lockoutDuration (seconds); never accepted from caller.

    • id
      Type: string Format: uuid
      required
    • lockoutStatus
      Type: string · LockoutStatusenum
      required

      Lockout lifecycle state

      values
      • active
      • expired
      • revoked
    • organizationId
      Type: string Format: uuid
      required
    • revokedAt
      Type: string | null Format: date-time
      required

      Reserved for

    • revokedByUserId
      Type: string | null Format: uuid
      required

      Reserved for

    • revokeReason
      Type: string | null
      required

      Reserved for

    • ruleSlug
      Type: string | null
      required

      Denormalized slug of the rule that tripped the lockout. Clients render lockout copy from this slug rather than fetching triggeringInsightId. Null when the lockout was created without a triggering rule.

    • scopeId
      Type: string | null Format: uuid
      required

      LtiApplication ID when scopeType='application'; null when scopeType='global'

    • scopeType
      Type: string · LockoutScopeTypeenum
      required

      Lockout scope discriminator

      values
      • application
      • global
    • startsAt
      Type: string Format: date-time
      required

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

    • triggeringCaliperSessionId
      Type: string | null
      required

      External Caliper session id of the triggering session, resolved from triggeringSessionId. Lets a consumer key a follow-up event (e.g. locked_out_restart) on the same external session id as the rest of the session's events. Null when the lockout has no triggering session or it is not yet materialized.

    • triggeringInsightId
      Type: string | null Format: uuid
      required
    • triggeringSessionId
      Type: string | null Format: uuid
      required

      Internal insights_session.id of the triggering session (audit pointer); not an external/Caliper id.

    • userId
      Type: string Format: uuid
      required
  • notifications
    Type: array object[] · SessionEnforcementNotificationOutput[]
    required
    • disputed
      Type: boolean
      required
    • endedAtTime
      Type: string Format: date-time
      required

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

    • insightId
      Type: string Format: uuid
      required
    • insightTypeSlug
      Type: string
      required
    • showStudentMessage
      Type: boolean
      required
    • signalId
      Type: string | null
      required
    • startedAtTime
      Type: string Format: date-time
      required

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

    • strikeKey
      Type: string | null
      required
    • version
      Type: integer | null
      required

      Org-pinned catalog message-bundle version (insights_org_policy.active_message_version), matching getInsightCatalog numbering so clients resolve slug@version copy. Null when the slug has no resolvable policy snapshot entry.

  • organizationId
    Type: string Format: uuid
    required
  • requiredAction
    Type: string enum
    required
    values
    • NONE
    • RESUME
    • END_SESSION
  • signalOutcomes
    Type: array object[] · SessionEnforcementSignalOutcomeOutput[]
    required
    • insightId
      Type: string | null Format: uuid
      required
    • outcome
      Type: string enum
      required
      values
      • ACCRUED
      • NOT_ENFORCED
      • DISPUTED
      • RELEASED
    • signalId
      Type: string
      required
    • strikeKey
      Type: string
      required
  • strikes
    Type: array object[] · SessionEnforcementStrikeOutput[]
    required
    • requiredAction
      Type: string enum
      required
      values
      • NONE
      • RESUME
      • END_SESSION
    • strikeCount
      Type: integer
      required

      Integer numbers.

    • strikeKey
      Type: string
      required
    • warningBudget
      Type: integer
      required

      Integer numbers.

  • userId
    Type: string Format: uuid
    required