Skip to content

Instantly share code, notes, and snippets.

@nielsvanvelzen
Last active February 13, 2024 06:43
  • Star 22 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
Star You must be signed in to star a gist
Save nielsvanvelzen/ea047d9028f676185832e51ffaf12a6f to your computer and use it in GitHub Desktop.
Jellyfin API Authorization

Jellyfin API Authorization

To start using the Jellyfin API, authorization is probably the first thing you'll need to do. Jellyfin's authorization options can be a bit confusing because there are a lot of deprecated options.

Generally there are three ways to authenticate: no authorization, user authorization with an access token or authorization with an API key. The first way is easy, just do nothing. But most often you'll need to use either the access token or API key.

Sending authorization values

There are multiple methods for transmitting authorization values, however, some are outdated and scheduled to be removed. It's recommend to use the Authorization header. If header auth isn't an option, the token should be sent through the ApiKey query parameter.

Type Name Method Deprecated
Header Authorization Schema No
Query ApiKey Token only No
Query api_key Token only yes
Header X-Emby-Token Token only yes
Header X-MediaBrowser-Token Token only yes
Header X-Emby-Authorization Schema yes

Avoid sending multiple tokens in one request as it's uncertain which value will be used. Deprecated options might be removed in future server updates.

The Jellyfin authorization scheme

The Authorization header uses the format Authorization: <scheme> <parameters>. The Jellyfin scheme is named MediaBrowser and it uses named values separated by commas. There is no specific order for parameters. All keys are case sensitive and only allow alphanumeric characters. Unknown keys are ignored by the server. Values must be wrapped in double quotes (") and should use url encoding.

MediaBrowser key="value", key2="value2", key3="value3"

Parameters

Key Description
Token The access token or API key
Client The name of the client
Version The version of the client
DeviceId A unique id for the device generated by the client
Device The device name

The token parameter is required to use authenticated endpoints. The client and version properties are used to identify the client in the dashboard.

Device identifiers

When it comes to device identifiers in the Jellyfin API, it's important to understand the nuances involved. While generating a random string for the deviceId might seem like a straightforward solution, there are certain limitations to consider. Currently, the server permits only a single access token for each deviceId. This means that you cannot have multiple users signed into your client with a single randomized string. To work around this limitation, you'll need to use a unique identifier for each combination of a device-specific identifier and user-specific identifier.

Since it's often not possible to know the user identifier before signing in at least once, we recommend including the username as user-specific identifier. It is advisable to hash the username because it is user-input that could include double quotes (escaping the header value format) or special characters that your HTTP library might not allow.

Examples

Here are a couple of examples for the authorization header:

  • Authenticate with API key

    Authorization: MediaBrowser Token="8ac3a7abaff943ba9adea7f8754da7f8"
  • Authenticate with access token

    Authorization: MediaBrowser Token="0381cf931f9e42d79fb9c89f729167df", Client="Android TV", Device="Nvidia Shield", DeviceId="ZQ9YQHHrUzk24vV", Version="0.15.3"

The ApiKey query parameter

Use the ApiKey query parameter when the Authorization header can't be used. The value of the query parameter is the access token or API key. Avoid using this option if possible. Never use the ApiKey query parameter and the Authorization header at the same time.

@JoshuaMorley
Copy link

This is really well done! Wish I had this months ago when I was trying to figure it out 😅

@nielsvanvelzen
Copy link
Author

I'm glad to hear you find this useful! Our intention is to create a proper developer site and this is one of the first pages I wrote for it because I'm well aware authentication is one of the things most developers have troubles with.

@jitprosen360
Copy link

I am trying to integrate with react axios authentication. Can anyone help me ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment