connect.users
connect.users
User resources.
Classes
| Name | Description |
|---|---|
| User | |
| Users | Users resource. |
User
connect.users.User(self, /, params, **kwargs)
Attributes
| Name | Description |
|---|---|
| content |
Methods
| Name | Description |
|---|---|
| lock | Locks the user account. |
| unlock | Unlocks the user account. |
| update | Update the user. |
lock
connect.users.User.lock(force=False)
Locks the user account.
.. warning:: You cannot unlock your own account. Once an account is locked, only an admin can unlock it.
Args: force (bool, optional): If set to True, overrides lock protection allowing a user to lock their own account. Defaults to False.
Returns
| Type | Description |
|---|---|
| None |
unlock
connect.users.User.unlock()
Unlocks the user account.
Returns
| Type | Description |
|---|---|
| None |
update
connect.users.User.update(*args, **kwargs)
Update the user.
Args: *args **kwargs
Returns
| Type | Description |
|---|---|
| None |
Users
connect.users.Users(self, params)
Users resource.
Methods
| Name | Description |
|---|---|
| count | |
| find | |
| find_one | |
| get |
count
connect.users.Users.count()
find
connect.users.Users.find(**kwargs)
find_one
connect.users.Users.find_one(**kwargs)
get
connect.users.Users.get(uid)