Skip to content

User

User(subsonic, username, password=None, email=None, ldap_authenticated=None, admin_role=None, settings_role=None, stream_role=None, jukebox_role=None, download_role=None, upload_role=None, playlist_role=None, cover_art_role=None, comment_role=None, podcast_role=None, share_role=None, video_conversion_role=None, music_folder_id=None, max_bit_rate=None)

Bases: Model

Object that holds all the info about a user.

Attributes:

Name Type Description
username str

The username of the user.
password str | None

The password of the user.
email str | None

The email of the user.
ldap_authenticated bool | None

If the user is has been authenticated using LDAP.
admin_role bool | None

If the user has access to admin functionalities.
settings_role bool | None

If the user has access to change the settings of the server.
stream_role bool | None

If the user has access to stream media.
jukebox_role bool | None

If the user has access to control the jukebox.
download_role bool | None

If the user has access to download media.
upload_role bool | None

If the user has access to upload media.
playlist_role bool | None

If the user has access to create, edit and delete playlists.
cover_art_role bool | None

If the user has access to manipulate cover arts of media.
comment_role bool | None

If the user has access to manipulate comments.
podcast_role bool | None

If the user has access to manipulate podcasts.
share_role bool | None

If the user has access to create, modify and delete shares.
video_conversion_role bool | None

If the user is able to trigger video conversions.
music_folder_id list[str] | None

The IDs of the music folders where the user is able to access content from.
max_bit_rate int | None

The max bit rate the user can stream.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_user.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def __init__(
    self,
    subsonic: "Subsonic",
    username: str,
    password: str | None = None,
    email: str | None = None,
    ldap_authenticated: bool | None = None,
    admin_role: bool | None = None,
    settings_role: bool | None = None,
    stream_role: bool | None = None,
    jukebox_role: bool | None = None,
    download_role: bool | None = None,
    upload_role: bool | None = None,
    playlist_role: bool | None = None,
    cover_art_role: bool | None = None,
    comment_role: bool | None = None,
    podcast_role: bool | None = None,
    share_role: bool | None = None,
    video_conversion_role: bool | None = None,
    music_folder_id: list[str] | None = None,
    max_bit_rate: int | None = None,
) -> None:
    super().__init__(subsonic)

    self.username = username
    self.password = password
    self.email = email
    self.ldap_authenticated = ldap_authenticated
    self.admin_role = admin_role
    self.settings_role = settings_role
    self.stream_role = stream_role
    self.jukebox_role = jukebox_role
    self.download_role = download_role
    self.upload_role = upload_role
    self.playlist_role = playlist_role
    self.cover_art_role = cover_art_role
    self.comment_role = comment_role
    self.podcast_role = podcast_role
    self.share_role = share_role
    self.video_conversion_role = video_conversion_role
    self.music_folder_id = music_folder_id
    self.max_bit_rate = max_bit_rate

change_password(new_password)

Change the password of the user.

Parameters:

Name Type Description Default
new_password str

The new password for the user

 required

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_user.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
def change_password(self, new_password: str) -> Self:
    """Change the password of the user.

    Args:
        new_password: The new password for the user

    Returns:
        The object itself.
    """

    self._subsonic.user_management.change_password(self.username, new_password)

    return self

create()

Create a new user with the attributes of the model.

Raises:

Type Description
MissingRequiredProperty

Raised if a required property to create the user is missing.

Returns: The object itself.

Source code in .venv/lib/python3.11/site-packages/knuckles/models/_user.py 
 99
100
101
102
103
104
105
106
107
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
def create(self) -> Self:
    """Create a new user with the attributes of the model.

    Raises:
        MissingRequiredProperty: Raised if a required property to create
            the user is missing.
    Returns:
        The object itself.
    """

    if not self.email:
        raise MissingRequiredProperty(
            "You must provide an email in the email property of the model"
        )

    if not self.password:
        raise MissingRequiredProperty(
            "You must provide an password in the password property of the model"
        )

    self._subsonic.user_management.create_user(
        self.username,
        self.password,
        self.email,
        self.ldap_authenticated,
        self.admin_role,
        self.settings_role,
        self.stream_role,
        self.jukebox_role,
        self.download_role,
        self.upload_role,
        self.playlist_role,
        self.cover_art_role,
        self.comment_role,
        self.podcast_role,
        self.share_role,
        self.video_conversion_role,
        self.music_folder_id,
        self.max_bit_rate,
    )

    return self

delete()

Delete the user from the server.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_user.py 
173
174
175
176
177
178
179
180
181
182
def delete(self) -> Self:
    """Delete the user from the server.

    Returns:
        The object itself.
    """

    self._subsonic.user_management.delete_user(self.username)

    return self

generate()

Return a new user object with all the data updated from the API, using the endpoint that return the most information possible.

Useful for making copies with updated data or updating the object itself with immutability, e.g., foo = foo.generate().

Returns:

Type Description
User

A new object with all the updated info.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_user.py 
86
87
88
89
90
91
92
93
94
95
96
97
def generate(self) -> "User":
    """Return a new user object with all the data updated from the API,
    using the endpoint that return the most information possible.

    Useful for making copies with updated data or updating the object
    itself with immutability, e.g., `foo = foo.generate()`.

    Returns:
        A new object with all the updated info.
    """

    return self._subsonic.user_management.get_user(self.username)

update()

Updates the info about the user in the server with the one in the model.

Returns:

Type Description
Self

The object itself.
Source code in .venv/lib/python3.11/site-packages/knuckles/models/_user.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def update(self) -> Self:
    """Updates the info about the user in the server with
    the one in the model.

    Returns:
        The object itself.
    """

    self._subsonic.user_management.update_user(
        self.username,
        self.password,
        self.email,
        self.ldap_authenticated,
        self.admin_role,
        self.settings_role,
        self.stream_role,
        self.jukebox_role,
        self.download_role,
        self.upload_role,
        self.playlist_role,
        self.cover_art_role,
        self.comment_role,
        self.podcast_role,
        self.share_role,
        self.video_conversion_role,
        self.music_folder_id,
        self.max_bit_rate,
    )

    return self