In this repository, you'll find all the information about integrating Auth0 with Python.
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.
The Authentication SDK is organized into components that mirror the structure of the API documentation. For example:
from auth0.v3.authentication import Social
social = Social('myaccount.auth0.com')
social.login(client_id='...', access_token='...', connection='facebook')
If you need to sign up a user using their email and password, you can use the Database object.
from auth0.v3.authentication import Database
database = Database('myaccount.auth0.com'')
database.signup(client_id='...', email='[email protected]', password='secr3t', connection='Username-Password-Authentication')
If you need to authenticate a user using their email and password, you can use the GetToken
object, which enables making requests to the /oauth/token
endpoint.
from auth0.v3.authentication import GetToken
token = GetToken('myaccount.auth0.com')
token.login(client_id='...', client_secret='...', username='[email protected]', password='secr3t', realm='Username-Password-Authentication')
Upon successful authentication, the credentials received may include an id_token
, if the authentication request contained the openid
scope. The id_token
contains information associated with the authenticated user. You can read more about ID tokens here.
Before you access its contents, you must verify that the ID token has not been tampered with and that it is meant for your application to consume. The TokenVerifier
class can be used to perform this verification.
To create a TokenVerifier
, the following arguments are required:
* A SignatureVerifier
instance, which is responsible for verifying the token's algorithm name and signature.
* The expected issuer value, which typically matches the Auth0 domain prefixed with https://
and suffixed with /
.
* The expected audience value, which typically matches the Auth0 application client ID.
The type of SignatureVerifier
used depends upon the signing algorithm used by your Auth0 application. You can view this value in your application settings under Advanced settings | OAuth | JsonWebToken Signature Algorithm
. Auth0 recommends using the RS256 asymmetric signing algorithm. You can read more about signing algorithms here.
For asymmetric algorithms like RS256, use the AsymmetricSignatureVerifier
class, passing
the public URL where the certificates for the public keys can be found. This will typically be your Auth0 domain with the /.well-known/jwks.json
path appended to it. For example, https://your-domain.auth0.com/.well-known/jwks.json
.
For symmetric algorithms like HS256, use the SymmetricSignatureVerifier
class, passing the value of the client secret of your Auth0 application.
The following example demonstrates the verification of an ID token signed with the RS256 signing algorithm:
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)
If the token verification fails, a TokenValidationError
will be raised. In that scenario, the ID token should be deemed invalid and its contents should not be trusted.
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.
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.
- Users (
authentication.Users
) - Database (
authentication.Database
) - Delegated (
authentication.Delegated
) - Enterprise (
authentication.Enterprise
) - Passwordless (
authentication.Passwordless
) - Social (
authentication.Social
) - API Authorization - Get Token (
authentication.GetToken
) - API Authorization - Authorization Code Grant (
authentication.AuthorizeClient
)
- Blacklists() (
Auth0().blacklists
) - Clients() (
Auth0().clients
) - ClientGrants() (
Auth0().client_grants
) - CustomDomains() (
Auth0().custom_domains
) - Connections() (
Auth0().connections
) - DeviceCredentials() (
Auth0().device_credentials
) - Emails() (
Auth0().emails
) - EmailTemplates() (
Auth0().email_templates
) - Grants() (
Auth0().grants
) - Guardian() (
Auth0().guardian
) - Jobs() (
Auth0().jobs
) - Logs() (
Auth0().logs
) - LogStreams() (
Auth0().log_streams
) - ResourceServers() (
Auth0().resource_servers
) - Roles() (
Auth0().roles
) - Rules() (
Auth0().rules
) - RulesConfigs() (
Auth0().rules_configs
) - Stats() (
Auth0().stats
) - Tenants() (
Auth0().tenants
) - Tickets() (
Auth0().tickets
) - UserBlocks() (
Auth0().user_blocks
) - Users() (
Auth0().users
) - UsersByEmail() (
Auth0().users_by_email
)
Please see CHANGELOG.md.
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.
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.
- Go to Auth0 and click Sign Up.
- Use Google, GitHub or Microsoft Account to log in.
This project is licensed under the MIT license. See the LICENSE file for more info.