1google-auth
2===========
3
4.. toctree::
5   :hidden:
6   :maxdepth: 2
7
8   user-guide
9   Reference <reference/modules>
10
11google-auth is the Google authentication library for Python. This library
12provides the ability to authenticate to Google APIs using various methods. It
13also provides integration with several HTTP libraries.
14
15- Support for Google :func:`Application Default Credentials <google.auth.default>`.
16- Support for signing and verifying :mod:`JWTs <google.auth.jwt>`.
17- Support for creating `Google ID Tokens <user-guide.html#identity-tokens>`__.
18- Support for verifying and decoding :mod:`ID Tokens <google.oauth2.id_token>`.
19- Support for Google :mod:`Service Account credentials <google.oauth2.service_account>`.
20- Support for Google :mod:`Impersonated Credentials <google.auth.impersonated_credentials>`.
21- Support for :mod:`Google Compute Engine credentials <google.auth.compute_engine>`.
22- Support for :mod:`Google App Engine standard credentials <google.auth.app_engine>`.
23- Support for :mod:`Identity Pool credentials <google.auth.identity_pool>`.
24- Support for :mod:`AWS credentials <google.auth.aws>`.
25- Support for :mod:`Downscoping with Credential Access Boundaries credentials <google.auth.downscoped>`.
26- Support for various transports, including
27  :mod:`Requests <google.auth.transport.requests>`,
28  :mod:`urllib3 <google.auth.transport.urllib3>`, and
29  :mod:`gRPC <google.auth.transport.grpc>`.
30
31.. note:: ``oauth2client`` was recently deprecated in favor of this library. For more details on the deprecation, see :doc:`oauth2client-deprecation`.
32
33Installing
34----------
35
36google-auth can be installed with `pip`_::
37
38    $ pip install --upgrade google-auth
39
40google-auth is open-source, so you can alternatively grab the source code from
41`GitHub`_ and install from source.
42
43
44For more information on setting up your Python development environment, please refer to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
45
46.. _`Python Development Environment Setup Guide`: https://cloud.google.com/python/setup
47.. _pip: https://pip.pypa.io
48.. _GitHub: https://github.com/GoogleCloudPlatform/google-auth-library-python
49
50Usage
51-----
52
53The :doc:`user-guide` is the place to go to learn how to use the library and
54accomplish common tasks.
55
56The :doc:`Module Reference <reference/modules>` documentation provides API-level documentation.
57
58License
59-------
60
61google-auth is made available under the Apache License, Version 2.0. For more
62details, see `LICENSE`_
63
64.. _LICENSE:
65    https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/main/LICENSE
66
67Contributing
68------------
69
70We happily welcome contributions, please see our `contributing`_ documentation
71for details.
72
73.. _contributing:
74    https://github.com/GoogleCloudPlatform/google-auth-library-python/blob/main/CONTRIBUTING.rst
75