User Admin Create Dto
immichpy.client.generated.models.user_admin_create_dto.UserAdminCreateDto
pydantic-model
Bases: BaseModel
UserAdminCreateDto
Show JSON schema:
{
"$defs": {
"UserAvatarColor": {
"description": "User avatar color",
"enum": [
"primary",
"pink",
"red",
"yellow",
"blue",
"green",
"purple",
"orange",
"gray",
"amber"
],
"title": "UserAvatarColor",
"type": "string"
}
},
"description": "UserAdminCreateDto",
"properties": {
"avatarColor": {
"anyOf": [
{
"$ref": "#/$defs/UserAvatarColor"
},
{
"type": "null"
}
],
"default": null
},
"email": {
"description": "User email",
"title": "Email",
"type": "string"
},
"isAdmin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Grant admin privileges",
"title": "Isadmin"
},
"name": {
"description": "User name",
"title": "Name",
"type": "string"
},
"notify": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Send notification email",
"title": "Notify"
},
"password": {
"description": "User password",
"title": "Password",
"type": "string"
},
"pinCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "PIN code",
"examples": [
"123456"
],
"title": "Pincode"
},
"quotaSizeInBytes": {
"anyOf": [
{
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Storage quota in bytes",
"title": "Quotasizeinbytes"
},
"shouldChangePassword": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Require password change on next login",
"title": "Shouldchangepassword"
},
"storageLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Storage label",
"title": "Storagelabel"
}
},
"required": [
"email",
"name",
"password"
],
"title": "UserAdminCreateDto",
"type": "object"
}
Config:
validate_by_name:Truevalidate_by_alias:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
avatar_color(Optional[UserAvatarColor]) -
email(Annotated[str, Field(strict=True)]) -
is_admin(Optional[StrictBool]) -
name(StrictStr) -
notify(Optional[StrictBool]) -
password(StrictStr) -
pin_code(Optional[Annotated[str, Field(strict=True)]]) -
quota_size_in_bytes(Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]]) -
should_change_password(Optional[StrictBool]) -
storage_label(Optional[StrictStr])
Validators:
email
pydantic-field
email: Annotated[str, Field(strict=True)]
User email
is_admin
pydantic-field
is_admin: Optional[StrictBool] = None
Grant admin privileges
name
pydantic-field
name: StrictStr
User name
notify
pydantic-field
notify: Optional[StrictBool] = None
Send notification email
password
pydantic-field
password: StrictStr
User password
pin_code
pydantic-field
pin_code: Optional[Annotated[str, Field(strict=True)]] = None
PIN code
quota_size_in_bytes
pydantic-field
quota_size_in_bytes: Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]] = None
Storage quota in bytes
should_change_password
pydantic-field
should_change_password: Optional[StrictBool] = None
Require password change on next login
storage_label
pydantic-field
storage_label: Optional[StrictStr] = None
Storage label
email_validate_regular_expression
pydantic-validator
email_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/user_admin_create_dto.py
82 83 84 85 86 87 88 89 90 91 92 | |
from_dict
classmethod
from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of UserAdminCreateDto from a dict
Source code in immichpy/client/generated/models/user_admin_create_dto.py
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | |
from_json
classmethod
from_json(json_str: str) -> Optional[Self]
Create an instance of UserAdminCreateDto from a JSON string
Source code in immichpy/client/generated/models/user_admin_create_dto.py
119 120 121 122 | |
pin_code_validate_regular_expression
pydantic-validator
pin_code_validate_regular_expression(value)
Validates the regular expression
Source code in immichpy/client/generated/models/user_admin_create_dto.py
94 95 96 97 98 99 100 101 102 | |
to_dict
to_dict() -> Dict[str, Any]
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic's
self.model_dump(by_alias=True):
Noneis only added to the output dict for nullable fields that were set at model initialization. Other fields with valueNoneare ignored.
Source code in immichpy/client/generated/models/user_admin_create_dto.py
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
to_json
to_json() -> str
Returns the JSON representation of the model using alias
Source code in immichpy/client/generated/models/user_admin_create_dto.py
115 116 117 | |
to_str
to_str() -> str
Returns the string representation of the model using alias
Source code in immichpy/client/generated/models/user_admin_create_dto.py
111 112 113 | |