Skip to content

Users models

Request and response types for the Users API.

models

Classes:

UserCreate

Bases: BaseModelWithConfig

Attributes:

email instance-attribute

email: str

first_name instance-attribute

first_name: str

last_name instance-attribute

last_name: str

password instance-attribute

password: str

phone_number instance-attribute

phone_number: str

roles class-attribute instance-attribute

roles: list[str] | None = None

If left blank(None), the user will be created without roles. Currently reflected as an array with an empty string in it ([""])

username instance-attribute

username: str

UserCreateResponse

Bases: BaseModelWithConfig

Attributes:

id instance-attribute

id: str

UserError

Bases: BaseModelWithConfig

Attributes:

response instance-attribute

response: bool

UserInstance

Bases: BaseModelWithConfig

Attributes:

admin_roles instance-attribute

admin_roles: list[str]

email instance-attribute

email: str

first_name instance-attribute

first_name: str

id instance-attribute

id: str

last_name instance-attribute

last_name: str

password_hash instance-attribute

password_hash: str

phone_number instance-attribute

phone_number: str

roles instance-attribute

roles: list[str]

An empty roles set is represented as an array with an empty string in it ([""])

subscriber_id instance-attribute

subscriber_id: str

username instance-attribute

username: str

UserPatch

Bases: BaseModelWithConfig

Attributes:

email class-attribute instance-attribute

email: str | None = None

first_name class-attribute instance-attribute

first_name: str | None = None

last_name class-attribute instance-attribute

last_name: str | None = None

password class-attribute instance-attribute

password: str | None = None

phone_number class-attribute instance-attribute

phone_number: str | None = None

roles class-attribute instance-attribute

roles: list[str] | None = None

UserResponse

Bases: BaseModelWithConfig

Attributes:

users instance-attribute

UserUpdate

Bases: BaseModelWithConfig

Attributes:

email instance-attribute

email: str

first_name instance-attribute

first_name: str

last_name instance-attribute

last_name: str

password instance-attribute

password: str

phone_number instance-attribute

phone_number: str

roles instance-attribute

roles: list[str] | None