Skip to content

User Admin Response Dto

immichpy.client.generated.models.user_admin_response_dto.UserAdminResponseDto pydantic-model

Bases: BaseModel

UserAdminResponseDto

Show JSON schema: 
{
  "$defs": {
    "UserAvatarColor": {
      "description": "Avatar color",
      "enum": [
        "primary",
        "pink",
        "red",
        "yellow",
        "blue",
        "green",
        "purple",
        "orange",
        "gray",
        "amber"
      ],
      "title": "UserAvatarColor",
      "type": "string"
    },
    "UserLicense": {
      "description": "UserLicense",
      "properties": {
        "activatedAt": {
          "description": "Activation date",
          "format": "date-time",
          "title": "Activatedat",
          "type": "string"
        },
        "activationKey": {
          "description": "Activation key",
          "title": "Activationkey",
          "type": "string"
        },
        "licenseKey": {
          "description": "License key",
          "title": "Licensekey",
          "type": "string"
        }
      },
      "required": [
        "activatedAt",
        "activationKey",
        "licenseKey"
      ],
      "title": "UserLicense",
      "type": "object"
    },
    "UserStatus": {
      "description": "User status",
      "enum": [
        "active",
        "removing",
        "deleted"
      ],
      "title": "UserStatus",
      "type": "string"
    }
  },
  "description": "UserAdminResponseDto",
  "properties": {
    "avatarColor": {
      "$ref": "#/$defs/UserAvatarColor"
    },
    "createdAt": {
      "description": "Creation date",
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "deletedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Deletion date",
      "title": "Deletedat"
    },
    "email": {
      "description": "User email",
      "title": "Email",
      "type": "string"
    },
    "id": {
      "description": "User ID",
      "title": "Id",
      "type": "string"
    },
    "isAdmin": {
      "description": "Is admin user",
      "title": "Isadmin",
      "type": "boolean"
    },
    "license": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserLicense"
        },
        {
          "type": "null"
        }
      ],
      "description": "User license"
    },
    "name": {
      "description": "User name",
      "title": "Name",
      "type": "string"
    },
    "oauthId": {
      "description": "OAuth ID",
      "title": "Oauthid",
      "type": "string"
    },
    "profileChangedAt": {
      "description": "Profile change date",
      "format": "date-time",
      "title": "Profilechangedat",
      "type": "string"
    },
    "profileImagePath": {
      "description": "Profile image path",
      "title": "Profileimagepath",
      "type": "string"
    },
    "quotaSizeInBytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Storage quota in bytes",
      "title": "Quotasizeinbytes"
    },
    "quotaUsageInBytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Storage usage in bytes",
      "title": "Quotausageinbytes"
    },
    "shouldChangePassword": {
      "description": "Require password change on next login",
      "title": "Shouldchangepassword",
      "type": "boolean"
    },
    "status": {
      "$ref": "#/$defs/UserStatus"
    },
    "storageLabel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Storage label",
      "title": "Storagelabel"
    },
    "updatedAt": {
      "description": "Last update date",
      "format": "date-time",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "avatarColor",
    "createdAt",
    "deletedAt",
    "email",
    "id",
    "isAdmin",
    "license",
    "name",
    "oauthId",
    "profileChangedAt",
    "profileImagePath",
    "quotaSizeInBytes",
    "quotaUsageInBytes",
    "shouldChangePassword",
    "status",
    "storageLabel",
    "updatedAt"
  ],
  "title": "UserAdminResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

avatar_color pydantic-field 

avatar_color: UserAvatarColor

Avatar color

created_at pydantic-field 

created_at: datetime

Creation date

deleted_at pydantic-field 

deleted_at: Optional[datetime]

Deletion date

email pydantic-field 

email: StrictStr

User email

id pydantic-field 

id: StrictStr

User ID

is_admin pydantic-field 

is_admin: StrictBool

Is admin user

license pydantic-field 

license: Optional[UserLicense]

User license

name pydantic-field 

name: StrictStr

User name

oauth_id pydantic-field 

oauth_id: StrictStr

OAuth ID

profile_changed_at pydantic-field 

profile_changed_at: datetime

Profile change date

profile_image_path pydantic-field 

profile_image_path: StrictStr

Profile image path

quota_size_in_bytes pydantic-field 

quota_size_in_bytes: Optional[StrictInt]

Storage quota in bytes

quota_usage_in_bytes pydantic-field 

quota_usage_in_bytes: Optional[StrictInt]

Storage usage in bytes

should_change_password pydantic-field 

should_change_password: StrictBool

Require password change on next login

status pydantic-field 

status: UserStatus

User status

storage_label pydantic-field 

storage_label: Optional[StrictStr]

Storage label

updated_at pydantic-field 

updated_at: datetime

Last update date

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of UserAdminResponseDto from a dict

Source code in immichpy/client/generated/models/user_admin_response_dto.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UserAdminResponseDto from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate(
        {
            "avatarColor": obj.get("avatarColor"),
            "createdAt": obj.get("createdAt"),
            "deletedAt": obj.get("deletedAt"),
            "email": obj.get("email"),
            "id": obj.get("id"),
            "isAdmin": obj.get("isAdmin"),
            "license": UserLicense.from_dict(obj["license"])
            if obj.get("license") is not None
            else None,
            "name": obj.get("name"),
            "oauthId": obj.get("oauthId"),
            "profileChangedAt": obj.get("profileChangedAt"),
            "profileImagePath": obj.get("profileImagePath"),
            "quotaSizeInBytes": obj.get("quotaSizeInBytes"),
            "quotaUsageInBytes": obj.get("quotaUsageInBytes"),
            "shouldChangePassword": obj.get("shouldChangePassword"),
            "status": obj.get("status"),
            "storageLabel": obj.get("storageLabel"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of UserAdminResponseDto from a JSON string

Source code in immichpy/client/generated/models/user_admin_response_dto.py 
103
104
105
106
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UserAdminResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

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):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Source code in immichpy/client/generated/models/user_admin_response_dto.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
def to_dict(self) -> 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)`:

    * `None` is only added to the output dict for nullable fields that
      were set at model initialization. Other fields with value `None`
      are ignored.
    """
    excluded_fields: Set[str] = set([])

    _dict = self.model_dump(
        by_alias=True,
        exclude=excluded_fields,
        exclude_none=True,
    )
    # override the default output from pydantic by calling `to_dict()` of license
    if self.license:
        _dict["license"] = self.license.to_dict()
    # set to None if deleted_at (nullable) is None
    # and model_fields_set contains the field
    if self.deleted_at is None and "deleted_at" in self.model_fields_set:
        _dict["deletedAt"] = None

    # set to None if license (nullable) is None
    # and model_fields_set contains the field
    if self.license is None and "license" in self.model_fields_set:
        _dict["license"] = None

    # set to None if quota_size_in_bytes (nullable) is None
    # and model_fields_set contains the field
    if (
        self.quota_size_in_bytes is None
        and "quota_size_in_bytes" in self.model_fields_set
    ):
        _dict["quotaSizeInBytes"] = None

    # set to None if quota_usage_in_bytes (nullable) is None
    # and model_fields_set contains the field
    if (
        self.quota_usage_in_bytes is None
        and "quota_usage_in_bytes" in self.model_fields_set
    ):
        _dict["quotaUsageInBytes"] = None

    # set to None if storage_label (nullable) is None
    # and model_fields_set contains the field
    if self.storage_label is None and "storage_label" in self.model_fields_set:
        _dict["storageLabel"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/user_admin_response_dto.py 
 98
 99
100
101
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
    return json.dumps(self.to_dict())

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/user_admin_response_dto.py 
94
95
96
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))