plexruby/docs/sdks/authentication

Authentication

Overview

API Calls regarding authentication for Plex Media Server

Available Operations

• get_transient_token - Get a Transient Token
• get_source_connection_information - Get Source Connection Information
• get_token_details - Get Token Details
• post_users_sign_in_data - Get User Sign In Data

get_transient_token

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

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.authentication.get_transient_token(type=::PlexRubySDK::Operations::GetTransientTokenQueryParamType::DELEGATION, scope=::PlexRubySDK::Operations::Scope::ALL)

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
type	::PlexRubySDK::Operations::GetTransientTokenQueryParamType	✔️	delegation - This is the only supported type parameter.
scope	::PlexRubySDK::Operations::Scope	✔️	all - This is the only supported scope parameter.

Response

T.nilable(::PlexRubySDK::Operations::GetTransientTokenResponse)

get_source_connection_information

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

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.authentication.get_source_connection_information(source="server://client-identifier")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
source	::String	✔️	The source identifier with an included prefix.	server://client-identifier

Response

T.nilable(::PlexRubySDK::Operations::GetSourceConnectionInformationResponse)

get_token_details

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

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
    )
s.config_security(
  ::PlexRubySDK::Shared::Security.new(
    access_token: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.authentication.get_token_details()

if ! res.user_plex_account.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
server_url	String	➖	An optional server URL to use.

Response

T.nilable(::PlexRubySDK::Operations::GetTokenDetailsResponse)

post_users_sign_in_data

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

Example Usage

require 'plex_ruby_sdk'


s = ::PlexRubySDK::PlexAPI.new(
      x_plex_client_identifier: "gcgzw5rz2xovp84b4vha3a40",
    )

    
res = s.authentication.post_users_sign_in_data(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", request_body=::PlexRubySDK::Operations::PostUsersSignInDataRequestBody.new(
  login: "username@email.com",
  password: "password123",
  verification_code: "123456",
))

if ! res.user_plex_account.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description	Example
x_plex_client_identifier	::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
request_body	::PlexRubySDK::Operations::PostUsersSignInDataRequestBody	➖	Login credentials
server_url	String	➖	An optional server URL to use.	http://localhost:8080

Response

T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataResponse)