lms.djangoapps.bulk_user_retirement package

lms.djangoapps.bulk_user_retirement package#

Submodules#

lms.djangoapps.bulk_user_retirement.urls module#

Defines the URL route for this app.

lms.djangoapps.bulk_user_retirement.views module#

An API for retiring user accounts.

class lms.djangoapps.bulk_user_retirement.views.BulkUsersRetirementView(**kwargs)#

Bases: APIView

Use Case

Implementation for Bulk User Retirement API. Creates a retirement request for one or more users.

Example Request

POST /v1/accounts/bulk_retire_users {

“usernames”: “test_user1, test_user2”

}

POST Parameters

A POST request can include the following parameter.

  • usernames: Comma separated strings of usernames that should be retired.

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>, <class 'openedx.core.djangoapps.user_api.accounts.permissions.CanRetireUser'>)#
post(request, **kwargs)#

Initiates the bulk retirement process for the given users.

Module contents#