Skip to content

Commit 654f25b

Browse files
authored
Add removeHomeUser
Add ability to remove a Home User. If Home User is an Existing Plex User then User will go back into Sharing/Friends with sections and settings carrying over. Any Home User settings (LiveTV) are removed.
1 parent a7df2a9 commit 654f25b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

plexapi/myplex.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ class MyPlexAccount(PlexObject):
6767
FRIENDSERVERS = 'https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}' # put with data
6868
PLEXSERVERS = 'https://plex.tv/api/servers/{machineId}' # get
6969
FRIENDUPDATE = 'https://plex.tv/api/friends/{userId}' # put with args, delete
70+
REMOVEHOMEUSER = 'https://plex.tv/api/home/users/{userId}' # delete
7071
REMOVEINVITE = 'https://plex.tv/api/invites/requested/{userId}?friend=0&server=1&home=0' # delete
7172
REQUESTED = 'https://plex.tv/api/invites/requested' # get
7273
REQUESTS = 'https://plex.tv/api/invites/requests' # get
@@ -339,6 +340,16 @@ def removeFriend(self, user):
339340
url = url.format(userId=user.id)
340341
return self.query(url, self._session.delete)
341342

343+
def removeHomeUser(self, user):
344+
""" Remove the specified managed user from home.
345+
346+
Parameters:
347+
user (str): MyPlexUser, username, email of the user to be removed from home.
348+
"""
349+
user = self.user(user)
350+
url = self.REMOVEHOMEUSER.format(userId=user.id)
351+
return self.query(url, self._session.delete)
352+
342353
def updateFriend(self, user, server, sections=None, removeSections=False, allowSync=None, allowCameraUpload=None,
343354
allowChannels=None, filterMovies=None, filterTelevision=None, filterMusic=None):
344355
""" Update the specified user's share settings.

0 commit comments

Comments
 (0)