API ReferenceUsers

Shorten User License

If the user already has access to the “Classroom” version up to a certain time, this shortens/revokes his/her access. If the ends is less than or equal to the current time, it revokes the enrollment and sets the end date to be the current time, else it just shortens the enrollment.

Path parameters

handlestringRequired

The document’s _id or slug.

Headers

AuthorizationstringRequired

Basic authentication of the form Basic <username:password>.

Request

This endpoint expects an object.
endsstringRequired

Response

This endpoint returns an object.
_idstring or null
emailstring or null
namestring or null
slugstring or null
rolestring or null
Usually either 'teacher' or 'student'
statsobject or null
oAuthIdentitieslist of objects or null
subscriptionobject or null
licenseobject or null