User

Introduction #

The CanvasUser model represents a Canvas User.

Basic usage #

To get a user by identifier, use the get method on the CanvasUser model manager:

from canvas_sdk.v1.data import CanvasUser

user = CanvasUser.objects.get(dbid="b80b1cdc2e6a4aca90ccebc02e683f35")

Filtering #

Users can be filtered by any attribute that exists on the model.

Filtering for users is done with the filter method on the CanvasUser model manager.

By attribute #

Specify attributes with filter to filter by those attributes:

from canvas_sdk.v1.data import CanvasUser

users = CanvasUser.objects.filter(phone_number="1111111111", email="test@canvasmedical.com")

Attributes #

User #

Field NameType
dbidInteger
emailString
phone_numberString




Questions? Create an issue.
On this page