mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-09 20:57:44 +00:00
63 lines
3.1 KiB
Markdown
63 lines
3.1 KiB
Markdown
# Users
|
|
(*users*)
|
|
|
|
## Overview
|
|
|
|
### Available Operations
|
|
|
|
* [get_users](#get_users) - Get list of all connected users
|
|
|
|
## get_users
|
|
|
|
Get list of all users that are friends and have library access with the provided Plex authentication token
|
|
|
|
### Example Usage
|
|
|
|
```python
|
|
from plex_api_client import PlexAPI
|
|
|
|
|
|
with PlexAPI() as plex_api:
|
|
|
|
res = plex_api.users.get_users(request={
|
|
"client_id": "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
|
"x_plex_token": "CV5xoxjTpFKUzBTShsaf",
|
|
"client_name": "Plex for Roku",
|
|
"device_nickname": "Roku 3",
|
|
"device_name": "Chrome",
|
|
"device_screen_resolution": "1487x1165,2560x1440",
|
|
"client_version": "2.4.1",
|
|
"platform": "Roku",
|
|
"client_features": "external-media,indirect-media,hub-style-list",
|
|
"model": "4200X",
|
|
"x_plex_session_id": "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
|
|
"x_plex_language": "en",
|
|
"platform_version": "4.3 build 1057",
|
|
})
|
|
|
|
assert res.body is not None
|
|
|
|
# Handle response
|
|
print(res.body)
|
|
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetUsersRequest](../../models/operations/getusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |
|
|
|
|
### Response
|
|
|
|
**[operations.GetUsersResponse](../../models/operations/getusersresponse.md)**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| --------------------------- | --------------------------- | --------------------------- |
|
|
| errors.GetUsersBadRequest | 400 | application/json |
|
|
| errors.GetUsersUnauthorized | 401 | application/json |
|
|
| errors.SDKError | 4XX, 5XX | \*/\* | |