{
  "opencollection": "1.0.0",
  "info": {
    "name": "D2L Brightspace Valence Learning Framework Assignments Enrollments API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://auth.brightspace.com/oauth2/auth",
      "accessTokenUrl": "https://auth.brightspace.com/core/connect/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Enrollments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users enrolled in an org unit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/d2l/api/lp/1.53/enrollments/orgUnits/:orgUnitId/users/",
            "params": [
              {
                "name": "orgUnitId",
                "value": "",
                "type": "path"
              },
              {
                "name": "roleId",
                "value": "",
                "type": "query"
              },
              {
                "name": "bookmark",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a paged list of the users enrolled in the identified org unit, optionally filtered by roleId."
        },
        {
          "info": {
            "name": "List org units a user is enrolled in",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/d2l/api/lp/1.53/enrollments/users/:userId/orgUnits/",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "bookmark",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a paged list of the org units the identified user is enrolled in."
        },
        {
          "info": {
            "name": "List the caller's enrollments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/d2l/api/lp/1.53/enrollments/myenrollments/",
            "params": [
              {
                "name": "bookmark",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a paged list of the current user's own enrollments."
        },
        {
          "info": {
            "name": "Enroll a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/d2l/api/lp/1.53/enrollments/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enrolls a user in an org unit with a specified role."
        },
        {
          "info": {
            "name": "Get a user's enrollment in an org unit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/d2l/api/lp/1.53/enrollments/orgUnits/:orgUnitId/users/:userId",
            "params": [
              {
                "name": "orgUnitId",
                "value": "",
                "type": "path"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves the enrollment record for a user in an org unit."
        },
        {
          "info": {
            "name": "Unenroll a user from an org unit",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/d2l/api/lp/1.53/enrollments/orgUnits/:orgUnitId/users/:userId",
            "params": [
              {
                "name": "orgUnitId",
                "value": "",
                "type": "path"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Removes the identified user's enrollment from the identified org unit."
        }
      ]
    }
  ],
  "bundled": true
}