plexgo/docs/sdks/authentication

Authentication

(Authentication)

Overview

API Calls regarding authentication for Plex Media Server

Available Operations

• GetTransientToken - Get a Transient Token
• GetSourceConnectionInformation - Get Source Connection Information
• GetTokenDetails - Get Token Details
• PostUsersSignInData - Get User Sign In Data

GetTransientToken

This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Authentication.GetTransientToken(ctx, operations.GetTransientTokenQueryParamTypeDelegation, operations.ScopeAll)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
type_	operations.GetTransientTokenQueryParamType	✔️	delegation - This is the only supported type parameter.
scope	operations.Scope	✔️	all - This is the only supported scope parameter.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetTransientTokenResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetTransientTokenBadRequest	400	application/json
sdkerrors.GetTransientTokenUnauthorized	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetSourceConnectionInformation

If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. Note: requires Plex Media Server >= 1.15.4.

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Authentication.GetSourceConnectionInformation(ctx, "server://client-identifier")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
source	string	✔️	The source identifier with an included prefix.	server://client-identifier
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetSourceConnectionInformationResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetSourceConnectionInformationBadRequest	400	application/json
sdkerrors.GetSourceConnectionInformationUnauthorized	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetTokenDetails

Get the User data from the provided X-Plex-Token

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Authentication.GetTokenDetails(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.UserPlexAccount != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetTokenDetailsResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetTokenDetailsBadRequest	400	application/json
sdkerrors.GetTokenDetailsUnauthorized	401	application/json
sdkerrors.SDKError	4xx-5xx	/

PostUsersSignInData

Sign in user with username and password and return user data with Plex authentication token

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Authentication.PostUsersSignInData(ctx, plexgo.String("gcgzw5rz2xovp84b4vha3a40"), &operations.PostUsersSignInDataRequestBody{
        Login: "username@email.com",
        Password: "password123",
        VerificationCode: plexgo.String("123456"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.UserPlexAccount != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
xPlexClientIdentifier	*string	➖	The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)	gcgzw5rz2xovp84b4vha3a40
requestBody	*operations.PostUsersSignInDataRequestBody	➖	Login credentials
opts	[]operations.Option	➖	The options for this request.

Response

*operations.PostUsersSignInDataResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.PostUsersSignInDataBadRequest	400	application/json
sdkerrors.PostUsersSignInDataUnauthorized	401	application/json
sdkerrors.SDKError	4xx-5xx	/