Easy Authentication for Requests
Project description
Easy Authentication for Requests
This module provides you authentication classes to be used with requests module.
To use a specific authentication in combination with requests, use the authentication parameter on requests module.
OAuth 2
Sample:
import requests
from requests_auth.authentication import OAuth2
requests.get('http://www.example.com', auth=OAuth2('https://www.example.com'))Parameters
Description |
Mandatory |
Default value |
|
|---|---|---|---|
authorization_url |
OAuth 2 authorization URL. |
Mandatory |
|
redirect_uri_endpoint |
Custom endpoint that will be used as redirect_uri the following way: http://localhost:<redirect_uri_port>/<redirect_uri_endpoint>. |
Optional |
‘’ |
redirect_uri_port |
The port on which the server listening for the OAuth 2 token will be started. |
Optional |
5000 |
redirect_uri_port_availability_timeout |
The maximum amount of seconds to wait for the redirect_uri_port to become available. |
Optional |
2 |
token_reception_timeout |
Maximum amount of seconds to wait for a token to be received once requested. |
Optional |
60 |
token_reception_success_display_time |
In case a token is successfully received, this is the maximum amount of milliseconds the success page will be displayed in your browser. |
Optional |
1 |
token_reception_failure_display_time |
In case received token is not valid, this is the maximum amount of milliseconds the failure page will be displayed in your browser. |
Optional |
5000 |
any other parameter |
all additional authorization parameters that should be put as query parameter in the authorization URL. * client_id: Corresponding to your Application ID (in Microsoft Azure app portal) * response_type: id_token for Microsoft * nonce: Refer to OpenID ID Token specifications for more details |
Optional |
Managing token cache
To avoid asking for a new token every new request, a token cache is used.
Default cache is in memory but it is also possible to use a physical cache using the following method:
from requests_auth.authentication import OAuth2
from requests_auth.oauth2_tokens import JsonTokenFileCache
OAuth2.token_cache = JsonTokenFileCache('my_token_cache')Common OAuth2 providers
Microsoft
Sample:
import requests
from requests_auth.authentication import MicrosoftOAuth2
ms_auth = MicrosoftOAuth2(tenant_id='45239d18-c68c-4c47-8bdd-ce71ea1d50cd', client_id='54239d18-c68c-4c47-8bdd-ce71ea1d50cd', nonce='7362CAEA-9CA5-4B43-9BA3-34D7C303EBA7')
requests.get('http://www.example.com', auth=ms_auth)Parameters
Description |
Mandatory |
Default value |
|
|---|---|---|---|
tenant_id |
Microsoft Tenant Identifier (formatted as 45239d18-c68c-4c47-8bdd-ce71ea1d50cd). |
Mandatory |
|
client_id |
Microsoft Application Identifier (formatted as 45239d18-c68c-4c47-8bdd-ce71ea1d50cd). |
Mandatory |
|
nonce |
Refer to OpenID ID Token specifications for more details (formatted as 7362CAEA-9CA5-4B43-9BA3-34D7C303EBA7) |
Mandatory |
|
redirect_uri_endpoint |
Custom endpoint that will be used as redirect_uri the following way: http://localhost:<redirect_uri_port>/<redirect_uri_endpoint>. |
Optional |
‘’ |
redirect_uri_port |
The port on which the server listening for the OAuth 2 token will be started. |
Optional |
5000 |
redirect_uri_port_availability_timeout |
The maximum amount of seconds to wait for the redirect_uri_port to become available. |
Optional |
2 |
token_reception_timeout |
Maximum amount of seconds to wait for a token to be received once requested. |
Optional |
60 |
token_reception_success_display_time |
In case a token is successfully received, this is the maximum amount of milliseconds the success page will be displayed in your browser. |
Optional |
1 |
token_reception_failure_display_time |
In case received token is not valid, this is the maximum amount of milliseconds the failure page will be displayed in your browser. |
Optional |
5000 |
any other parameter |
all additional authorization parameters that should be put as query parameter in the authorization URL. |
Optional |
API key in header
Sample:
import requests
from requests_auth.authentication import HeaderApiKey
requests.get('http://www.example.com', auth=HeaderApiKey('my_api_key'))Parameters
Description |
Mandatory |
Default value |
|
|---|---|---|---|
api_key |
The API key that will be sent. |
Mandatory |
|
header_name |
Name of the header field. |
Optional |
“X-API-Key” |
API key in query
Sample:
import requests
from requests_auth.authentication import QueryApiKey
requests.get('http://www.example.com', auth=QueryApiKey('my_api_key'))Parameters
Description |
Mandatory |
Default value |
|
|---|---|---|---|
api_key |
The API key that will be sent. |
Mandatory |
|
query_parameter_name |
Name of the query parameter. |
Optional |
“api_key” |
Basic
Sample:
import requests
from requests_auth.authentication import Basic
requests.get('http://www.example.com', auth=Basic('username', 'password'))Parameters
Description |
Mandatory |
|
|---|---|---|
username |
User name. |
Mandatory |
password |
User password. |
Mandatory |
NTLM
Requires requests-negotiate-sspi module or requests_ntlm module depending on provided parameters.
Sample:
import requests
from requests_auth.authentication import NTLM
requests.get('http://www.example.com', auth=NTLM())Parameters
Description |
Mandatory |
|
|---|---|---|
username |
User name. |
Mandatory if requests_negotiate_sspi module is not installed. In such a case requests_ntlm module is mandatory. |
password |
User password. |
Mandatory if requests_negotiate_sspi module is not installed. In such a case requests_ntlm module is mandatory. |
Multiple authentication at once
You can also use a combination of authentication as in the following sample:
import requests
from requests_auth.authentication import Auths, HeaderApiKey, OAuth2
api_key = HeaderApiKey('my_api_key')
oauth2 = OAuth2('https://www.example.com')
requests.get('http://www.example.com', auth=Auths([api_key, oauth2]))Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
