Users models
Request and response types for the Users API.
models
Classes:
-
UserCreate– -
UserCreateResponse– -
UserError– -
UserInstance– -
UserPatch– -
UserResponse– -
UserUpdate–
UserCreate
Bases: BaseModelWithConfig
Attributes:
-
email(str) – -
first_name(str) – -
last_name(str) – -
password(str) – -
phone_number(str) – -
roles(list[str] | None) –If left blank(None), the user will be created without roles. Currently reflected as
-
username(str) –
roles
class-attribute
instance-attribute
If left blank(None), the user will be created without roles. Currently reflected as an array with an empty string in it ([""])
UserCreateResponse
UserError
UserInstance
Bases: BaseModelWithConfig
Attributes:
-
admin_roles(list[str]) – -
email(str) – -
first_name(str) – -
id(str) – -
last_name(str) – -
password_hash(str) – -
phone_number(str) – -
roles(list[str]) –An empty roles set is represented as an array with an empty string in it ([""])
-
subscriber_id(str) – -
username(str) –
roles
instance-attribute
An empty roles set is represented as an array with an empty string in it ([""])
UserPatch
Bases: BaseModelWithConfig
Attributes:
-
email(str | None) – -
first_name(str | None) – -
last_name(str | None) – -
password(str | None) – -
phone_number(str | None) – -
roles(list[str] | None) –