LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1

Browse Source
This commit is contained in:
speakeasybot
2025-02-06 00:22:53 +00:00
parent c431cee288
commit b10d5f7023
72 changed files with 1385 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/sdks/users/README.md Normal file
View File

@@ -0,0 +1,60 @@
# Users
(*Users*)
## Overview
### Available Operations
* [GetUsers](#getusers) - Get list of all connected users
## GetUsers
Get list of all users that are friends and have library access with the provided Plex authentication token
### Example Usage
```csharp
using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
var sdk = new PlexAPI();
GetUsersRequest req = new GetUsersRequest() {
ClientID = "3381b62b-9ab7-4e37-827b-203e9809eb58",
ClientName = "Plex for Roku",
DeviceNickname = "Roku 3",
DeviceName = "Chrome",
DeviceScreenResolution = "1487x1165,2560x1440",
ClientVersion = "2.4.1",
Platform = "Roku",
ClientFeatures = "external-media,indirect-media,hub-style-list",
Model = "4200X",
XPlexSessionId = "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
XPlexLanguage = "en",
PlatformVersion = "4.3 build 1057",
XPlexToken = "CV5xoxjTpFKUzBTShsaf",
};
var res = await sdk.Users.GetUsersAsync(req);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `request` | [GetUsersRequest](../../Models/Requests/GetUsersRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetUsersResponse](../../Models/Requests/GetUsersResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetUsersBadRequest | 400 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.GetUsersUnauthorized | 401 | application/json |
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |