auth

• Functions for interacting with authentication tokens to use with the API

• Also contains variables and functions intended for internal use

class DedicatedServerToken(audience: str, access_token: str, refresh_token: str, expiration: int = 0)

Bases: WebServicesToken

• a token for the private web services API

• learn more about a dedicated server account here: https://webservices.openplanet.dev/auth/dedi

Parameters:

• audience (str) –

  • audience for which token is valid

• access_token (str) –

  • main token used for authorization

• refresh_token (str) –

  • token used to refresh access token

• expiration (int) –

  • time at which access token will expire

  • if not given, will be decoded from the token’s payload

  • default: 0

static get(audience: str, login: str, password: str, agent: str) → DedicatedServerToken

• requests a dedicated server account token for a given audience

Parameters:

• audience (str) –

  • desired audience for token use

  • capitalization is ignored

  • valid: ‘NadeoServices’/’core’/’prod’, ‘NadeoLiveServices’/’live’/’meet’/’club’

• login (str) –

  • dedicated server account username

• password (str) –

  • dedicated server account password

• agent (str) –

  • user agent, ideally with your program’s name and a way to contact you

  • Nadeo can block your request without this being properly set

class JSONWebToken(token: str)

Bases: object

• a JSON web token in a base64-encoded string

static decode(token: str) → dict

• decodes a JSON web token into a dictionary using its payload section

• will fail if passed an invalid token

decoded: dict

token: str

class OAuthToken(identifier: str, secret: str, access_token: str, expiration: int = 0)

Bases: Token

• a token for the public Trackmania API

• learn more about the API here: https://webservices.openplanet.dev/oauth/auth

Parameters:

• identifier (str) –

  • client ID (username)

• secret (str) –

  • client secret (password)

• access_token (str) –

  • main token used for authorization

• expiration (int) –

  • time at which access token will expire

  • if not given, will be decoded from the token’s payload

  • default: 0

static check_type(token: Token, msg: str = '') → None

• checks that a token is for OAuth2 and throws a UsageError otherwise

Parameters:

• token (Token) –

  • authentication token

• msg (str) –

  • exception message to pass along if the check fails

  • default: ‘’ (empty)

static get(identifier: str, secret: str) → OAuthToken

• requests an authentication token

Parameters:

• identifier (str) –

  • username

• secret (str) –

  • password

identifier: str

refresh() → None

• refreshes token

• doesn’t actually refresh, rather this requests a new token

secret: str

class ServiceToken(audience: str, access_token: str, refresh_token: str, expiration: int = 0)

Bases: WebServicesToken

• a token for the private web services API

• learn more about a service account here: https://webservices.openplanet.dev/auth/service

Parameters:

• audience (str) –

  • audience for which token is valid

• access_token (str) –

  • main token used for authorization

• refresh_token (str) –

  • token used to refresh access token

• expiration (int) –

  • time at which access token will expire

  • if not given, will be decoded from the token’s payload

  • default: 0

account_id: str

static check_type(token: Token, msg: str = '') → None

• checks that a token is for a service account and throws a UsageError otherwise

Parameters:

• token (Token) –

  • authentication token

• msg (str) –

  • exception message to pass along if the check fails

  • default: ‘’ (empty)

static get(audience: str, login: str, password: str, agent: str) → ServiceToken

• requests a service account token for a given audience

Parameters:

• audience (str) –

  • desired audience for token use

  • capitalization is ignored

  • valid: ‘NadeoServices’/’core’/’prod’, ‘NadeoLiveServices’/’live’/’meet’/’club’

• login (str) –

  • service account username

• password (str) –

  • service account password

• agent (str) –

  • user agent, ideally with your program’s name and a way to contact you

  • Nadeo can block your request without this being properly set

class Token(audience: str, access_token: str, expiration: int = 0)

Bases: object

• a general authentication token

• does not contain a base URL as a token could be used for multiple

Parameters:

• audience (str) –

  • audience for which token is valid

• access_token (str) –

  • main token used for authorization

• refresh_token (str) –

  • token used to refresh access token (if applicable)

  • default: ‘’ (empty)

• expiration (int) –

  • time at which access token will expire

  • if not given, will be decoded from the token’s payload

  • default: 0

access_token: JSONWebToken

audience: str

expiration: int

property expired: bool

refresh() → None

• refreshes token(s)

static verify_audience(audience: str) → str

class WebServicesToken(audience: str, access_token: str, refresh_token: str, expiration: int = 0)

Bases: Token

• a token for the private web services API

Parameters:

• audience (str) –

  • audience for which token is valid

• access_token (str) –

  • main token used for authorization

• refresh_token (str) –

  • token used to refresh access token

• expiration (int) –

  • time at which access token will expire

  • if not given, will be decoded from the token’s payload

  • default: 0

check_audience(audience: str) → None

• checks that the token has the expected audience and throws an AudienceError otherwise

Parameters:

• token (WebServicesToken) –

  • authentication token

• audience (str) –

  • expected audience

static check_type(token: Token, msg: str = '') → None

• checks that a token is for web services and throws a UsageError otherwise

Parameters:

• token (Token) –

  • authentication token

• msg (str) –

  • exception message to pass along if the check fails

  • default: ‘’ (empty)

static get(audience: str, login: str, password: str, agent: str) → WebServicesToken

• requests a web services token for a given audience

• this token is not useful on its own, instead use a token for a specific account type

Parameters:

• audience (str) –

  • desired audience for token use

  • capitalization is ignored

  • valid: ‘NadeoServices’/’core’/’prod’, ‘NadeoLiveServices’/’live’/’meet’/’club’

• login (str) –

  • account username

• password (str) –

  • account password

• agent (str) –

  • user agent, ideally with your program’s name and a way to contact you

  • Nadeo can block your request without this being properly set

refresh() → None

• refreshes access and refresh tokens

refresh_token: JSONWebToken