Skip to content

Commit 65f02a7

Browse files
emar-karbusunkim96
authored andcommitted
docs: remove references to the old authentication credentials (#9456)
1 parent 7743e30 commit 65f02a7

6 files changed

Lines changed: 26 additions & 39 deletions

File tree

api_core/docs/auth.rst

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -177,22 +177,6 @@ described above,
177177
so be sure none of the other possible environments conflict
178178
with your user provided credentials.
179179

180-
Advanced users of `oauth2client`_ can also use custom flows to
181-
create credentials using `client secrets`_ or using a
182-
`webserver flow`_.
183-
After creation, :class:`Credentials <oauth2client.client.Credentials>`
184-
can be serialized with
185-
:meth:`to_json() <oauth2client.client.Credentials.to_json>`
186-
and stored in a file and then and deserialized with
187-
:meth:`from_json() <oauth2client.client.Credentials.from_json>`. In order
188-
to use ``oauth2client``'s credentials with this library, you'll need to
189-
`convert them`_.
190-
191-
.. _oauth2client: https://github.com/Google/oauth2client
192-
.. _client secrets: https://developers.google.com/api-client-library/python/guide/aaa_oauth#flow_from_clientsecrets
193-
.. _webserver flow: https://developers.google.com/api-client-library/python/guide/aaa_oauth#OAuth2WebServerFlow
194-
.. _convert them: http://google-auth.readthedocs.io/en/stable/user-guide.html#user-credentials
195-
196180
Troubleshooting
197181
===============
198182

error_reporting/google/cloud/error_reporting/_logging.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ class _ErrorReportingLoggingAPI(object):
3030
passed falls back to the default inferred from the
3131
environment.
3232
33-
:type credentials: :class:`oauth2client.client.OAuth2Credentials` or
33+
:type credentials: :class:`google.auth.credentials.Credentials` or
3434
:class:`NoneType`
35-
:param credentials: The OAuth2 Credentials to use for the connection
36-
owned by this client. If not passed (and if no
37-
``_http`` object is passed), falls back to the default
38-
inferred from the environment.
35+
:param credentials: The authorization credentials to attach to requests.
36+
These credentials identify this application to the service.
37+
If none are specified, the client will attempt to ascertain
38+
the credentials from the environment.
3939
4040
:type _http: :class:`~requests.Session`
4141
:param _http: (Optional) HTTP object to make requests. Can be any object

error_reporting/google/cloud/error_reporting/client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@ class Client(ClientWithProject):
9696
passed falls back to the default inferred from the
9797
environment.
9898
99-
:type credentials: :class:`oauth2client.client.OAuth2Credentials` or
99+
:type credentials: :class:`google.auth.credentials.Credentials` or
100100
:class:`NoneType`
101-
:param credentials: The OAuth2 Credentials to use for the connection
102-
owned by this client. If not passed (and if no
103-
``_http`` object is passed), falls back to the default
104-
inferred from the environment.
101+
:param credentials: The authorization credentials to attach to requests.
102+
These credentials identify this application to the service.
103+
If none are specified, the client will attempt to ascertain
104+
the credentials from the environment.
105105
106106
:type _http: :class:`~requests.Session`
107107
:param _http: (Optional) HTTP object to make requests. Can be any object

spanner/google/cloud/spanner_v1/client.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,12 @@ class Client(ClientWithProject):
9393
attempt to determine from the environment.
9494
9595
:type credentials:
96-
:class:`OAuth2Credentials <oauth2client.client.OAuth2Credentials>` or
96+
:class:`Credentials <google.auth.credentials.Credentials>` or
9797
:data:`NoneType <types.NoneType>`
98-
:param credentials: (Optional) The OAuth2 Credentials to use for this
99-
client. If not provided, defaults to the Google
100-
Application Default Credentials.
98+
:param credentials: (Optional) The authorization credentials to attach to requests.
99+
These credentials identify this application to the service.
100+
If none are specified, the client will attempt to ascertain
101+
the credentials from the environment.
101102
102103
:type client_info: :class:`google.api_core.gapic_v1.client_info.ClientInfo`
103104
:param client_info:
@@ -143,7 +144,7 @@ def credentials(self):
143144
"""Getter for client's credentials.
144145
145146
:rtype:
146-
:class:`OAuth2Credentials <oauth2client.client.OAuth2Credentials>`
147+
:class:`Credentials <google.auth.credentials.Credentials>`
147148
:returns: The credentials stored on the client.
148149
"""
149150
return self._credentials

storage/google/cloud/storage/blob.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -430,11 +430,12 @@ def generate_signed_url(
430430
to the ``client`` stored on the blob's bucket.
431431
432432
433-
:type credentials: :class:`oauth2client.client.OAuth2Credentials` or
433+
:type credentials: :class:`google.auth.credentials.Credentials` or
434434
:class:`NoneType`
435-
:param credentials: (Optional) The OAuth2 credentials to use to sign
436-
the URL. Defaults to the credentials stored on the
437-
client used.
435+
:param credentials: The authorization credentials to attach to requests.
436+
These credentials identify this application to the service.
437+
If none are specified, the client will attempt to ascertain
438+
the credentials from the environment.
438439
439440
:type version: str
440441
:param version: (Optional) The version of signed credential to create.

storage/google/cloud/storage/bucket.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2121,11 +2121,12 @@ def generate_signed_url(
21212121
to the ``client`` stored on the blob's bucket.
21222122
21232123
2124-
:type credentials: :class:`oauth2client.client.OAuth2Credentials` or
2124+
:type credentials: :class:`google.auth.credentials.Credentials` or
21252125
:class:`NoneType`
2126-
:param credentials: (Optional) The OAuth2 credentials to use to sign
2127-
the URL. Defaults to the credentials stored on the
2128-
client used.
2126+
:param credentials: The authorization credentials to attach to requests.
2127+
These credentials identify this application to the service.
2128+
If none are specified, the client will attempt to ascertain
2129+
the credentials from the environment.
21292130
21302131
:type version: str
21312132
:param version: (Optional) The version of signed credential to create.

0 commit comments

Comments
 (0)