Skip to content

rest_client

RestClient

Bases: object

A REST client that uses pydantic models to interpret response data

authenticate(username, password=None, save_credentials=None, **kwargs)

POSTs an OAuth2-compliant form to obtain a bearer token. Be sure to set the 'auth_route' property either in a subclass or manually (e.g. on init)

Parameters:

Name Type Description Default
username
required
password
None
save_credentials

whether to save credentials

None
kwargs
{}

Returns:

Type Description

reauthenticate(save_credentials=None, **kwargs)

If we have saved credentials, pass them along. update the flag

Parameters:

Name Type Description Default
save_credentials
None
kwargs
{}

Returns:

Type Description

set_token(token)

we accept: - a string with a plain token - a string with 'token_type token' - an OauthToken

Parameters:

Name Type Description Default
token
required

Returns:

Type Description