auth0-python 3.11.0

What is Auth0?

Auth0 helps you to:

• Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, among others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.

• Add authentication through more traditional username/password databases.

• Add support for linking different user accounts with the same user.

• Support for generating signed JSON Web Tokens to call your APIs and flow the user identity securely.

• Analytics of how, when and where users are logging in.

• Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a free Auth0 Account

1. Go to Auth0 and click Sign Up.

2. Use Google, GitHub or Microsoft Account to log in.

Installation

You can install the auth0 Python SDK using the following command.

pip install auth0-python

For python3, use the following command

pip3 install auth0-python

Python 3.2 and 3.3 have reached EOL and support will be removed in the near future.

Management SDK Usage

To use the management library you will need to instantiate an Auth0 object with a domain and a Management API v2 token. Please note that these token last 24 hours, so if you need it constantly you should ask for it programmatically using the client credentials grant with a non interactive client authorized to access the API. For example:

from auth0.v3.authentication import GetToken

domain = 'myaccount.auth0.com'
non_interactive_client_id = 'exampleid'
non_interactive_client_secret = 'examplesecret'

get_token = GetToken(domain)
token = get_token.client_credentials(non_interactive_client_id,
    non_interactive_client_secret, 'https://{}/api/v2/'.format(domain))
mgmt_api_token = token['access_token']

Then use the token you’ve obtained as follows:

from auth0.v3.management import Auth0

domain = 'myaccount.auth0.com'
mgmt_api_token = 'MGMT_API_TOKEN'

auth0 = Auth0(domain, mgmt_api_token)

The Auth0() object is now ready to take orders! Let’s see how we can use this to get all available connections. (this action requires the token to have the following scope: read:connections)

auth0.connections.all()

Which will yield a list of connections similar to this:

[
    {
        'enabled_clients': [u'rOsnWgtw23nje2QCDuDJNVpxlsCylSLE'],
        'id': u'con_ErZf9LpXQDE0cNBr',
        'name': u'Amazon-Connection',
        'options': {u'profile': True, u'scope': [u'profile']},
        'strategy': u'amazon'
    },
    {
        'enabled_clients': [u'rOsnWgtw23nje2QCDuDJNVpxlsCylSLE'],
        'id': u'con_i8qF5DPiZ3FdadwJ',
        'name': u'Username-Password-Authentication',
        'options': {u'brute_force_protection': True},
        'strategy': u'auth0'
    }
]

Modifying an existing connection is equally as easy. Let’s change the name of connection 'con_ErZf9LpXQDE0cNBr'. (The token will need scope: update:connections to make this one work)

auth0.connections.update('con_ErZf9LpXQDE0cNBr', {'name': 'MyNewName'})

That’s it! Using the get method of the connections endpoint we can verify that the rename actually happened.

modified_connection = auth0.connections.get('con_ErZf9LpXQDE0cNBr')

Which returns something like this

{
    'enabled_clients': [u'rOsnWgtw23nje2QCDuDJNVpxlsCylSLE'],
    'id': u'con_ErZf9LpXQDE0cNBr',
    'name': u'MyNewName',
    'options': {u'profile': True, u'scope': [u'profile']},
    'strategy': u'amazon'
}

Success!

All endpoints follow a similar structure to connections, and try to follow as closely as possible the API documentation.

Authentication SDK Usage

The Authentication SDK is divided into components mimicking the structure of the API’s documentation. For example:

from auth0.v3.authentication import Social

social = Social('myaccount.auth0.com')

s.login(client_id='...', access_token='...', connection='facebook')

ID Token validation

As the result of the authentication and among the credentials received, an id_token might be present. This artifact contains information associated to the user that has just logged in, provided the scope used contained openid. You can read more about ID tokens here.

Before you access their contents, you must first verify the ID token to ensure its contents has not been tampered with and that is meant for your application to consume.

For that purpose you use the TokenVerifier class, which requires to be passed a few options: * A SignatureVerifier instance, in charge of checking the expected algorithm and signature. * The expected issuer value, typically matches the Auth0 domain prefixed with https:// and suffixed with /. * The expected audience value, typically matches the Auth0 application client ID.

You choose the signature verifier depending on the signing algorithm used by your Auth0 application. You can check its value under Advanced settings | OAuth | JsonWebToken Signature Algorithm. * For symmetric algorithms like “HS256”, use the SymmetricSignatureVerifier class passing as secret the client secret value for your Auth0 application. * For asymmetric algorithms like “RS256”, use the AsymmetricSignatureVerifier class passing the public URL where the certificates for the public keys can be found.

Auth0 hosts Public Keys inside the .well-known directory of your tenant’s domain. That URL looks like this: https://myaccount.auth0.com/.well-known/jwks.json. After replacing myaccount.auth0.com with your tenant’s domain, you should be able to access your tenant’s public keys.

It is recommended that you make use of asymmetric signing algorithms as their keys are easier to rotate in case they need to be revoked.

With all in place, the next snippets shows how to verify an RS256 signed ID token:

from auth0.v3.authentication.token_verifier import TokenVerifier, AsymmetricSignatureVerifier

domain = 'myaccount.auth0.com'
client_id = 'exampleid'

# After authenticating
id_token = auth_result['id_token']

jwks_url = 'https://{}/.well-known/jwks.json'.format(domain)
issuer = 'https://{}/'.format(domain)

sv = AsymmetricSignatureVerifier(jwks_url)  # Reusable instance
tv = TokenVerifier(signature_verifier=sv, issuer=issuer, audience=client_id)
tv.verify(id_token)

Provided something goes wrong, a TokenValidationError will be raised. In this scenario, the ID token should be deemed invalid and its contents not be trusted.

Error Handling

When consuming methods from the API clients, the requests could fail for a number of reasons: - Invalid data sent as part of the request: An Auth0Error` is raised with the error code and description. - Global or Client Rate Limit reached: A ``RateLimitError is raised and the time at which the limit resets is exposed in the reset_at property. When the header is unset, this value will be -1. - Network timeouts: Adjustable by passing a timeout argument to the client. See the rate limit docs for details.

Change Log

Please see CHANGELOG.md.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.