Al-Farabi Kazakh National University

Al-Farabi Kazakh National University Edx Proctoring API

The edx_proctoring API from Al-Farabi Kazakh National University — 30 operation(s) for edx_proctoring.

Documentation GitHub OpenAPI

Business capability

Examination Operations BC-4740.20

Operations 45

POST /edx_proctoring/proctoring_review_callback/ Edx proctoring proctoring review callback create #

GET /edx_proctoring/v1/instructor/{course_id} Edx proctoring v1 instructor read #

GET /edx_proctoring/v1/instructor/{course_id}/{exam_id} Edx proctoring v1 instructor read #

GET /edx_proctoring/v1/proctored_exam/active_attempt Edx proctoring v1 proctored exam active attempt list #

GET /edx_proctoring/v1/proctored_exam/active_exams_for_user Edx proctoring v1 proctored exam active exams for user list #

GET /edx_proctoring/v1/proctored_exam/allowance Edx proctoring v1 proctored exam allowance list #

PUT /edx_proctoring/v1/proctored_exam/allowance Edx proctoring v1 proctored exam allowance update #

DELETE /edx_proctoring/v1/proctored_exam/allowance Edx proctoring v1 proctored exam allowance delete #

GET /edx_proctoring/v1/proctored_exam/attempt Edx proctoring v1 proctored exam attempt list #

POST /edx_proctoring/v1/proctored_exam/attempt Edx proctoring v1 proctored exam attempt create #

GET /edx_proctoring/v1/proctored_exam/attempt/course_id/{course_id} Edx proctoring v1 proctored exam attempt course id read #

GET /edx_proctoring/v1/proctored_exam/attempt/grouped/course_id/{course_id} Edx proctoring v1 proctored exam attempt grouped course id read #

GET /edx_proctoring/v1/proctored_exam/attempt/grouped/course_id/{course_id}/search/{search_by} Edx proctoring v1 proctored exam attempt grouped course id search read #

GET /edx_proctoring/v1/proctored_exam/attempt/{attempt_id} Edx proctoring v1 proctored exam attempt read #

PUT /edx_proctoring/v1/proctored_exam/attempt/{attempt_id} Edx proctoring v1 proctored exam attempt update #

DELETE /edx_proctoring/v1/proctored_exam/attempt/{attempt_id} Edx proctoring v1 proctored exam attempt delete #

PUT /edx_proctoring/v1/proctored_exam/attempt/{attempt_id}/review_status Edx proctoring v1 proctored exam attempt review status update #

POST /edx_proctoring/v1/proctored_exam/attempt/{external_id}/ready Edx proctoring v1 proctored exam attempt ready create #

POST /edx_proctoring/v1/proctored_exam/attempt/{external_id}/reviewed Edx proctoring v1 proctored exam attempt reviewed create #

PUT /edx_proctoring/v1/proctored_exam/bulk_allowance Edx proctoring v1 proctored exam bulk allowance update #

GET /edx_proctoring/v1/proctored_exam/exam Edx proctoring v1 proctored exam exam list #

POST /edx_proctoring/v1/proctored_exam/exam Edx proctoring v1 proctored exam exam create #

PUT /edx_proctoring/v1/proctored_exam/exam Edx proctoring v1 proctored exam exam update #

GET /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id} Edx proctoring v1 proctored exam exam course id read #

POST /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id} Edx proctoring v1 proctored exam exam course id create #

PUT /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id} Edx proctoring v1 proctored exam exam course id update #

GET /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id}/content_id/{content_id} Edx proctoring v1 proctored exam exam course id content id read #

POST /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id}/content_id/{content_id} Edx proctoring v1 proctored exam exam course id content id create #

PUT /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id}/content_id/{content_id} Edx proctoring v1 proctored exam exam course id content id update #

GET /edx_proctoring/v1/proctored_exam/exam/exam_id/{exam_id} Edx proctoring v1 proctored exam exam exam id read #

POST /edx_proctoring/v1/proctored_exam/exam/exam_id/{exam_id} Edx proctoring v1 proctored exam exam exam id create #

PUT /edx_proctoring/v1/proctored_exam/exam/exam_id/{exam_id} Edx proctoring v1 proctored exam exam exam id update #

DELETE /edx_proctoring/v1/proctored_exam/exam_id/{exam_id}/user_id/{user_id}/reset_attempts Edx proctoring v1 proctored exam exam id user id reset attempts delete #

PATCH /edx_proctoring/v1/proctored_exam/exam_registration/course_id/{course_id} Edx proctoring v1 proctored exam exam registration course id partial update #

GET /edx_proctoring/v1/proctored_exam/review_policy/exam_id/{exam_id}/ Edx proctoring v1 proctored exam review policy exam id read #

GET /edx_proctoring/v1/proctored_exam/settings/exam_id/{exam_id}/ Edx proctoring v1 proctored exam settings exam id read #

GET /edx_proctoring/v1/proctored_exam/{course_id}/allowance Edx proctoring v1 proctored exam allowance list #

PUT /edx_proctoring/v1/proctored_exam/{course_id}/allowance Edx proctoring v1 proctored exam allowance update #

DELETE /edx_proctoring/v1/proctored_exam/{course_id}/allowance Edx proctoring v1 proctored exam allowance delete #

PUT /edx_proctoring/v1/proctored_exam/{course_id}/bulk_allowance Edx proctoring v1 proctored exam bulk allowance update #

GET /edx_proctoring/v1/proctored_exam/{course_id}/grouped/allowance Edx proctoring v1 proctored exam grouped allowance list #

POST /edx_proctoring/v1/retire_backend_user/{user_id}/ Edx proctoring v1 retire backend user create #

POST /edx_proctoring/v1/retire_user/{user_id}/ Edx proctoring v1 retire user create #

GET /edx_proctoring/v1/user_onboarding/status Edx proctoring v1 user onboarding status list #

GET /edx_proctoring/v1/user_onboarding/status/course_id/{course_id} Edx proctoring v1 user onboarding status course id read #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/openapi/al-farabi-kazakh-national-university-edx-proctoring-api-openapi.yml

Other Resources

🔗

Swagger

https://open.kaznu.kz/swagger.json

🔗

x-json-schema

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/json-schema/al-farabi-kazakh-national-university-course-schema.json

🔗

x-json-structure

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/json-structure/al-farabi-kazakh-national-university-course-structure.json

🔗

x-examples

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/examples/al-farabi-kazakh-national-university-list-courses-example.json

🔗

x-spectral-rules

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/rules/al-farabi-kazakh-national-university-rules.yml

🔗

x-vocabulary

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/vocabulary/al-farabi-kazakh-national-university-vocabulary.yml

🔗

x-json-ld

https://raw.githubusercontent.com/api-evangelist/al-farabi-kazakh-national-university/refs/heads/main/json-ld/al-farabi-kazakh-national-university-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/al-farabi-kazakh-national-university:al-farabi-kazakh-national-university-edx-proctoring-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Open edX Edx Proctoring API
  description: APIs for access to Open edX information
  contact:
    email: dl@kaznu.kz
  version: v1
servers:
- url: https://open.kaznu.kz/api
security:
- Basic: []
tags:
- name: edx_proctoring
paths:
  /edx_proctoring/proctoring_review_callback/:
    post:
      operationId: edx_proctoring_proctoring_review_callback_create
      description: Post callback handler
      tags:
      - edx_proctoring
      responses:
        '201':
          description: ''
      summary: Edx proctoring proctoring review callback create
      x-summary-source: derived
  /edx_proctoring/v1/instructor/{course_id}:
    get:
      operationId: edx_proctoring_v1_instructor_read
      description: Redirect to dashboard for a given course and optional exam_id
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 instructor read
      x-summary-source: derived
  /edx_proctoring/v1/instructor/{course_id}/{exam_id}:
    get:
      operationId: getEdxProctoringV1InstructorByCourseIdByExamId
      description: Redirect to dashboard for a given course and optional exam_id
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 instructor read
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: edx_proctoring_v1_instructor_read
  /edx_proctoring/v1/proctored_exam/active_attempt:
    get:
      operationId: edx_proctoring_v1_proctored_exam_active_attempt_list
      description: HTTP GET handler. Returns active attempt
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam active attempt list
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/active_exams_for_user:
    get:
      operationId: edx_proctoring_v1_proctored_exam_active_exams_for_user_list
      description: Returns the get_active_exams_for_user
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam active exams for user list
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/allowance:
    get:
      operationId: edx_proctoring_v1_proctored_exam_allowance_list
      description: 'HTTP GET handler. Get all allowances for a course.

        Course and Global staff can view both timed and proctored exam allowances.'
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam allowance list
      x-summary-source: derived
    put:
      operationId: edx_proctoring_v1_proctored_exam_allowance_update
      description: HTTP GET handler. Adds or updates Allowance
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam allowance update
      x-summary-source: derived
    delete:
      operationId: edx_proctoring_v1_proctored_exam_allowance_delete
      description: HTTP DELETE handler. Removes Allowance.
      tags:
      - edx_proctoring
      responses:
        '204':
          description: ''
      summary: Edx proctoring v1 proctored exam allowance delete
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt:
    get:
      operationId: edx_proctoring_v1_proctored_exam_attempt_list
      description: HTTP GET Handler. Returns the status of the exam attempt.
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt list
      x-summary-source: derived
    post:
      operationId: edx_proctoring_v1_proctored_exam_attempt_create
      description: HTTP POST handler. To create an exam attempt.
      tags:
      - edx_proctoring
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt create
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/course_id/{course_id}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_attempt_course_id_read
      description: HTTP GET handler. Returns exam with attempt and active attempt
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt course id read
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/grouped/course_id/{course_id}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_attempt_grouped_course_id_read
      description: HTTP GET Handler.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt grouped course id read
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/grouped/course_id/{course_id}/search/{search_by}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_attempt_grouped_course_id_search_read
      description: HTTP GET Handler.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - name: search_by
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt grouped course id search read
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/{attempt_id}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_attempt_read
      description: HTTP GET Handler. Returns the status of the exam attempt.
      tags:
      - edx_proctoring
      parameters:
      - name: attempt_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt read
      x-summary-source: derived
    put:
      operationId: edx_proctoring_v1_proctored_exam_attempt_update
      description: HTTP PUT handler to update exam attempt status based on an action.
      tags:
      - edx_proctoring
      parameters:
      - name: attempt_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt update
      x-summary-source: derived
    delete:
      operationId: edx_proctoring_v1_proctored_exam_attempt_delete
      description: HTTP DELETE handler. Removes an exam attempt.
      tags:
      - edx_proctoring
      parameters:
      - name: attempt_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt delete
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/{attempt_id}/review_status:
    put:
      operationId: edx_proctoring_v1_proctored_exam_attempt_review_status_update
      description: Update the is_status_acknowledged flag for the specific attempt
      tags:
      - edx_proctoring
      parameters:
      - name: attempt_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt review status update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/{external_id}/ready:
    post:
      operationId: edx_proctoring_v1_proctored_exam_attempt_ready_create
      description: Post callback handler
      tags:
      - edx_proctoring
      parameters:
      - name: external_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt ready create
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/attempt/{external_id}/reviewed:
    post:
      operationId: edx_proctoring_v1_proctored_exam_attempt_reviewed_create
      description: 'Called when 3rd party proctoring service has finished its review of

        an attempt.'
      tags:
      - edx_proctoring
      parameters:
      - name: external_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam attempt reviewed create
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/bulk_allowance:
    put:
      operationId: edx_proctoring_v1_proctored_exam_bulk_allowance_update
      description: HTTP PUT handler. Adds or updates Allowances for many exams and students
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam bulk allowance update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/exam:
    get:
      operationId: edx_proctoring_v1_proctored_exam_exam_list
      description: 'HTTP GET handler.

        Scenarios:

        by exam_id: calls get_exam_by_id()

        by course_id, content_id: get_exam_by_content_id()'
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam list
      x-summary-source: derived
    post:
      operationId: edx_proctoring_v1_proctored_exam_exam_create
      description: Http POST handler. Creates an exam.
      tags:
      - edx_proctoring
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam exam create
      x-summary-source: derived
    put:
      operationId: edx_proctoring_v1_proctored_exam_exam_update
      description: 'HTTP PUT handler. To update an exam.

        calls the update_exam'
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_exam_course_id_read
      description: 'HTTP GET handler.

        Scenarios:

        by exam_id: calls get_exam_by_id()

        by course_id, content_id: get_exam_by_content_id()'
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam course id read
      x-summary-source: derived
    post:
      operationId: edx_proctoring_v1_proctored_exam_exam_course_id_create
      description: Http POST handler. Creates an exam.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam exam course id create
      x-summary-source: derived
    put:
      operationId: edx_proctoring_v1_proctored_exam_exam_course_id_update
      description: 'HTTP PUT handler. To update an exam.

        calls the update_exam'
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam course id update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/exam/course_id/{course_id}/content_id/{content_id}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_exam_course_id_content_id_read
      description: 'HTTP GET handler.

        Scenarios:

        by exam_id: calls get_exam_by_id()

        by course_id, content_id: get_exam_by_content_id()'
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - name: content_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam course id content id read
      x-summary-source: derived
    post:
      operationId: edx_proctoring_v1_proctored_exam_exam_course_id_content_id_create
      description: Http POST handler. Creates an exam.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - name: content_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam exam course id content id create
      x-summary-source: derived
    put:
      operationId: edx_proctoring_v1_proctored_exam_exam_course_id_content_id_update
      description: 'HTTP PUT handler. To update an exam.

        calls the update_exam'
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - name: content_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam course id content id update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/exam/exam_id/{exam_id}:
    get:
      operationId: edx_proctoring_v1_proctored_exam_exam_exam_id_read
      description: 'HTTP GET handler.

        Scenarios:

        by exam_id: calls get_exam_by_id()

        by course_id, content_id: get_exam_by_content_id()'
      tags:
      - edx_proctoring
      parameters:
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam exam id read
      x-summary-source: derived
    post:
      operationId: edx_proctoring_v1_proctored_exam_exam_exam_id_create
      description: Http POST handler. Creates an exam.
      tags:
      - edx_proctoring
      parameters:
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 proctored exam exam exam id create
      x-summary-source: derived
    put:
      operationId: edx_proctoring_v1_proctored_exam_exam_exam_id_update
      description: 'HTTP PUT handler. To update an exam.

        calls the update_exam'
      tags:
      - edx_proctoring
      parameters:
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam exam id update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/exam_id/{exam_id}/user_id/{user_id}/reset_attempts:
    delete:
      operationId: edx_proctoring_v1_proctored_exam_exam_id_user_id_reset_attempts_delete
      description: HTTP DELETE handler, deletes all attempts for a given exam and username
      tags:
      - edx_proctoring
      parameters:
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Edx proctoring v1 proctored exam exam id user id reset attempts delete
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/exam_registration/course_id/{course_id}:
    patch:
      operationId: edx_proctoring_v1_proctored_exam_exam_registration_course_id_partial_update
      description: 'Create or update a list of all active exams.

        Exams not included in the registration payload will be deactivated'
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam exam registration course id partial update
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/review_policy/exam_id/{exam_id}/:
    get:
      operationId: edx_proctoring_v1_proctored_exam_review_policy_exam_id_read
      description: HTTP GET handler. Returns review policy for proctored exam.
      tags:
      - edx_proctoring
      parameters:
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam review policy exam id read
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/settings/exam_id/{exam_id}/:
    get:
      operationId: edx_proctoring_v1_proctored_exam_settings_exam_id_read
      description: HTTP GET handler. Returns proctoring_settings and exam_proctoring_backend config for proctored exam.
      tags:
      - edx_proctoring
      parameters:
      - name: exam_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam settings exam id read
      x-summary-source: derived
  /edx_proctoring/v1/proctored_exam/{course_id}/allowance:
    get:
      operationId: getEdxProctoringV1ProctoredExamByCourseIdAllowance
      description: 'HTTP GET handler. Get all allowances for a course.

        Course and Global staff can view both timed and proctored exam allowances.'
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam allowance list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: edx_proctoring_v1_proctored_exam_allowance_list
    put:
      operationId: putEdxProctoringV1ProctoredExamByCourseIdAllowance
      description: HTTP GET handler. Adds or updates Allowance
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam allowance update
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: edx_proctoring_v1_proctored_exam_allowance_update
    delete:
      operationId: deleteEdxProctoringV1ProctoredExamByCourseIdAllowance
      description: HTTP DELETE handler. Removes Allowance.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Edx proctoring v1 proctored exam allowance delete
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: edx_proctoring_v1_proctored_exam_allowance_delete
  /edx_proctoring/v1/proctored_exam/{course_id}/bulk_allowance:
    put:
      operationId: putEdxProctoringV1ProctoredExamByCourseIdBulkAllowance
      description: HTTP PUT handler. Adds or updates Allowances for many exams and students
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam bulk allowance update
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: edx_proctoring_v1_proctored_exam_bulk_allowance_update
  /edx_proctoring/v1/proctored_exam/{course_id}/grouped/allowance:
    get:
      operationId: edx_proctoring_v1_proctored_exam_grouped_allowance_list
      description: HTTP GET Handler.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 proctored exam grouped allowance list
      x-summary-source: derived
  /edx_proctoring/v1/retire_backend_user/{user_id}/:
    post:
      operationId: edx_proctoring_v1_retire_backend_user_create
      description: 'Deletes all user data for the particular user_id

        from all configured backends'
      tags:
      - edx_proctoring
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 retire backend user create
      x-summary-source: derived
  /edx_proctoring/v1/retire_user/{user_id}/:
    post:
      operationId: edx_proctoring_v1_retire_user_create
      description: Obfuscates all PII for a given user_id
      tags:
      - edx_proctoring
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
      summary: Edx proctoring v1 retire user create
      x-summary-source: derived
  /edx_proctoring/v1/user_onboarding/status:
    get:
      operationId: edx_proctoring_v1_user_onboarding_status_list
      description: HTTP GET handler. Returns the learner's onboarding status.
      tags:
      - edx_proctoring
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 user onboarding status list
      x-summary-source: derived
  /edx_proctoring/v1/user_onboarding/status/course_id/{course_id}:
    get:
      operationId: edx_proctoring_v1_user_onboarding_status_course_id_read
      description: HTTP GET handler.
      tags:
      - edx_proctoring
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Edx proctoring v1 user onboarding status course id read
      x-summary-source: derived
components:
  securitySchemes:
    Basic:
      type: http
      scheme: basic