index.rst

google-auth

.. toctree::
   :hidden:
   :maxdepth: 2

   user-guide
   Reference <reference/modules>

google-auth is the Google authentication library for Python. This library provides the ability to authenticate to Google APIs using various methods. It also provides integration with several HTTP libraries.

• Support for Google :func:`Application Default Credentials <google.auth.default>`.
• Support for signing and verifying :mod:`JWTs <google.auth.jwt>`.
• Support for verifying and decoding :mod:`ID Tokens <google.oauth2.id_token>`.
• Support for Google :mod:`Service Account credentials <google.oauth2.service_account>`.
• Support for :mod:`Google Compute Engine credentials <google.auth.compute_engine>`.
• Support for :mod:`Google App Engine standard credentials <google.auth.app_engine>`.
• Support for various transports, including :mod:`Requests <google.auth.transport.requests>`, :mod:`urllib3 <google.auth.transport.urllib3>`, and :mod:`gRPC <google.auth.transport.grpc>`.

Note

oauth2client was recently deprecated in favor of this library. For more details on the deprecation, see :doc:`oauth2client-deprecation`.

Installing

google-auth can be installed with pip:

$ pip install --upgrade google-auth

google-auth is open-source, so you can alternatively grab the source code from GitHub and install from source.

For more information on setting up your Python development environment, please refer to Python Development Environment Setup Guide for Google Cloud Platform.

Usage

The :doc:`user-guide` is the place to go to learn how to use the library and accomplish common tasks.

The :doc:`Module Reference <reference/modules>` documentation provides API-level documentation.

License

google-auth is made available under the Apache License, Version 2.0. For more details, see LICENSE

Contributing

We happily welcome contributions, please see our contributing documentation for details.