User

py_moodle.user

User management module for Moodle.

Provides functions to list, create, and delete users using Moodle webservice API, with a fallback to form-based actions if webservice permissions are missing.

Classes:

Name	Description
MoodleUserError	Exception raised for errors in user operations.

Functions:

Name	Description
list_course_users	List all enrolled users in a specific course.
create_user	Create a new user, trying webservice first and falling back to form post.
delete_user	Delete a user, trying webservice first and falling back to form post.

Classes

MoodleUserError

Bases: Exception

Exception raised for errors in user operations.

Functions

list_course_users

list_course_users(
    session: Session,
    base_url: str,
    token: str,
    course_id: int,
) -> List[Dict[str, Any]]

List all enrolled users in a specific course.

create_user

create_user(
    session: Session,
    base_url: str,
    token: str,
    username: str,
    password: str,
    firstname: str,
    lastname: str,
    email: str,
    sesskey: Optional[str] = None,
    **kwargs: Any
) -> Dict[str, Any]

Create a new user, trying webservice first and falling back to form post.

delete_user

delete_user(
    session: Session,
    base_url: str,
    token: str,
    user_id: int,
    sesskey: Optional[str] = None,
) -> bool

Delete a user, trying webservice first and falling back to form post.