flywheel.models.user
User
Bases: object
api_key property writable
Gets the api_key of this User.
Returns:
| Type | Description |
|---|---|
UserApiKey | The api_key of this User |
api_keys property writable
Gets the api_keys of this User.
Returns:
| Type | Description |
|---|---|
list[UserApiKey] | The api_keys of this User |
avatar property writable
Gets the avatar of this User.
Avatar image URL
Returns:
| Type | Description |
|---|---|
str | The avatar of this User |
central_revision property writable
Gets the central_revision of this User.
Returns:
| Type | Description |
|---|---|
int | The central_revision of this User |
central_user_id property writable
Gets the central_user_id of this User.
Returns:
| Type | Description |
|---|---|
str | The central_user_id of this User |
created property writable
Gets the created of this User.
Creation time (automatically set)
Returns:
| Type | Description |
|---|---|
datetime | The created of this User |
deleted property writable
Gets the deleted of this User.
Deleted time (automatically set on delete)
Returns:
| Type | Description |
|---|---|
datetime | The deleted of this User |
disabled property writable
Gets the disabled of this User.
Returns:
| Type | Description |
|---|---|
bool | The disabled of this User |
email property writable
Gets the email of this User.
Email address
Returns:
| Type | Description |
|---|---|
str | The email of this User |
firstlogin property writable
Gets the firstlogin of this User.
Returns:
| Type | Description |
|---|---|
str | The firstlogin of this User |
firstname property writable
Gets the firstname of this User.
First name
Returns:
| Type | Description |
|---|---|
str | The firstname of this User |
id property writable
Gets the id of this User.
Database ID of a user
Returns:
| Type | Description |
|---|---|
str | The id of this User |
info property writable
Gets the info of this User.
Returns:
| Type | Description |
|---|---|
object | The info of this User |
lastlogin property writable
Gets the lastlogin of this User.
Returns:
| Type | Description |
|---|---|
str | The lastlogin of this User |
lastname property writable
Gets the lastname of this User.
Last name
Returns:
| Type | Description |
|---|---|
str | The lastname of this User |
modified property writable
Gets the modified of this User.
Last modification time (automatically updated)
Returns:
| Type | Description |
|---|---|
datetime | The modified of this User |
preferences property writable
Gets the preferences of this User.
Returns:
| Type | Description |
|---|---|
UserPreferences | The preferences of this User |
roles property writable
Gets the roles of this User.
Returns:
| Type | Description |
|---|---|
list[str] | The roles of this User |
root property writable
Gets the root of this User.
Super admin flag
Returns:
| Type | Description |
|---|---|
bool | The root of this User |
user_id property writable
Gets the user_id of this User.
Returns:
| Type | Description |
|---|---|
str | The user_id of this User |
__contains__(key)
Checks if the given value is a key in this object
__eq__(other)
Returns true if both objects are equal
__getitem__(key)
Returns the value of key
__init__(id=None, user_id=None, firstname=None, lastname=None, email=None, avatar=None, roles=None, root=None, disabled=None, preferences=None, firstlogin=None, lastlogin=None, api_key=None, api_keys=None, created=None, modified=None, deleted=None, central_user_id=None, central_revision=None, info=None)
User - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | (str, optional) | Database ID of a user, defaults to None | None |
user_id | (str, optional) | , defaults to None | None |
firstname | (str, optional) | First name, defaults to None | None |
lastname | (str, optional) | Last name, defaults to None | None |
email | (str, optional) | Email address, defaults to None | None |
avatar | (str, optional) | Avatar image URL, defaults to None | None |
roles | (list[str], optional) | , defaults to None | None |
root | (bool, optional) | Super admin flag, defaults to None | None |
disabled | (bool, optional) | , defaults to None | None |
preferences | (UserPreferences, optional) | , defaults to None | None |
firstlogin | (str, optional) | , defaults to None | None |
lastlogin | (str, optional) | , defaults to None | None |
api_key | (UserApiKey, optional) | , defaults to None | None |
api_keys | (list[UserApiKey], optional) | , defaults to None | None |
created | (datetime, optional) | Creation time (automatically set), defaults to None | None |
modified | (datetime, optional) | Last modification time (automatically updated), defaults to None | None |
deleted | (datetime, optional) | Deleted time (automatically set on delete), defaults to None | None |
central_user_id | (str, optional) | , defaults to None | None |
central_revision | (int, optional) | , defaults to None | None |
info | (object, optional) | , defaults to None | None |
__ne__(other)
Returns true if both objects are not equal
__repr__()
For print and pprint
__setitem__(key, value)
Sets the value of key
get(key, default=None)
Get the value of the provided json property, or default
items()
Returns the list of json property to value mapping
keys()
Returns the list of json properties in the object
positional_to_model(value) staticmethod
Converts a positional argument to a model value
return_value()
Unwraps return value from model
to_dict()
Returns the model properties as a dict
to_str()
Returns the string representation of the model
values()
Returns the list of values in the object