https://github.com/brenekh/go-plexauth
A Go utility to quickly authenticate a third party application with a Plex account.
https://github.com/brenekh/go-plexauth
authentication command-line go golang golang-library plex plex-media-server plexmediaserver
Last synced: 10 months ago
JSON representation
A Go utility to quickly authenticate a third party application with a Plex account.
- Host: GitHub
- URL: https://github.com/brenekh/go-plexauth
- Owner: BrenekH
- License: apache-2.0
- Created: 2021-12-30T01:31:10.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-07T06:23:40.000Z (about 4 years ago)
- Last Synced: 2024-12-25T07:18:25.455Z (about 1 year ago)
- Topics: authentication, command-line, go, golang, golang-library, plex, plex-media-server, plexmediaserver
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Plex Authentication (in Go!)
[](https://pkg.go.dev/github.com/BrenekH/go-plexauth)
[](https://github.com/BrenekH/go-plexauth/tree/master/LICENSE)
This tool is based on the instructions available in [this Plex forum post](https://forums.plex.tv/t/authenticating-with-plex/609370), which you should look over to understand the authentication flow.
To reiterate the high level steps, a PIN must be generated and formed into a URL that the user can visit which allows them to claim the PIN.
After the PIN has been claimed, the Plex API will return an authentication token which can be used to access the Plex API on the user's behalf.
Go PlexAuth automates this process making it easy to obtain a permanent auth token for API calls.
## Installation
As a Go library: `go get github.com/BrenekH/go-plexauth`
As a CLI: `go install github.com/BrenekH/go-plexauth/cli@latest`
## Usage
### CLI
Run the executable and enter a device name.
You will then need to visit the URL it prints out to the console to complete the authentication.
Once authentication is complete, your authentication token will be printed to the console.
### Go Library
Basic example:
```go
package main
import (
"fmt"
"github.com/BrenekH/go-plexauth"
)
func main() {
clientID := "my-random-client-id"
// Request that Plex generate a new PIN for a user to claim.
pinID, pinCode, err := plexauth.GetPlexPIN(appName, clientID)
if err != nil {
panic(err)
}
// Create the URL that the user needs to visit to claim the PIN.
authUrl, err := plexauth.GenerateAuthURL(appName, clientID, pinCode, plexauth.ExtraAuthURLOptions{})
if err != nil {
panic(err)
}
// Inform the user of the URL they need to visit. Typically this would
// automatically open the browser, but here it is printed to the console for simplicity's sake.
fmt.Printf("Please visit %s to authenticate.\n", authUrl)
// Repeatedly ask Plex if the PIN has been claimed yet. Times out after 30 minutes.
authToken, err := plexauth.PollForAuthToken(context.Background(), pinID, pinCode, clientID)
if err != nil {
panic(err)
}
fmt.Printf("Your authentication token is \"%s\"\n", authToken)
}
```
For the full documentation, visit [pkg.go.dev/github.com/BrenekH/go-plexauth](https://pkg.go.dev/github.com/BrenekH/go-plexauth).
## License
This project is licensed under the Apache 2.0 License, a copy of which can be found in [LICENSE](https://github.com/BrenekH/go-plexauth/tree/master/LICENSE).