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.383.2

Browse Source
This commit is contained in:
speakeasybot
2024-08-30 00:10:10 +00:00
parent cc8bc7366d
commit ec1b25e152
148 changed files with 1044 additions and 954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/sdks/authentication/README.md
View File

@@ -10,6 +10,7 @@ API Calls regarding authentication for Plex Media Server
* [GetTransientToken](#gettransienttoken) - Get a Transient Token.
* [GetSourceConnectionInformation](#getsourceconnectioninformation) - Get Source Connection Information
* [PostUsersSignInData](#postuserssignindata) - Get User SignIn Data
## GetTransientToken
@@ -25,11 +26,13 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Authentication.GetTransientTokenAsync(
type: PlexAPI.Models.Requests.GetTransientTokenQueryParamType.Delegation,
scope: PlexAPI.Models.Requests.Scope.All);
scope: PlexAPI.Models.Requests.Scope.All
);
// handle response
```
@@ -68,7 +71,8 @@ using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman");
xPlexClientIdentifier: "Postman"
);
var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "server://client-identifier");
@@ -91,3 +95,47 @@ var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| PlexAPI.Models.Errors.GetSourceConnectionInformationResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## PostUsersSignInData
Sign in user with username and password and return user data with Plex authentication token
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(xPlexClientIdentifier: "Postman");
var res = await sdk.Authentication.PostUsersSignInDataAsync(
xPlexClientIdentifier: "Postman",
requestBody: new PostUsersSignInDataRequestBody() {
Login = "username@email.com",
Password = "password123",
}
);
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `RequestBody` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
**[PostUsersSignInDataResponse](../../Models/Requests/PostUsersSignInDataResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| PlexAPI.Models.Errors.PostUsersSignInDataResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |