Python 2.7 has reached end of supportand will bedeprecatedon January 31, 2026. After deprecation, you won't be able to deploy Python 2.7applications, even if your organization previously used an organization policy tore-enable deployments of legacy runtimes. Your existing Python2.7 applications will continue to run and receive traffic after theirdeprecation date. We recommend thatyoumigrate to the latest supported version of Python.

google.appengine.api.oauth package

Summary

OAuth API module.

Sub Modules

google.appengine.api.oauth.oauth_api

OAuth API.

Contents

exceptiongoogle.appengine.api.oauth.Errorsource

Bases: exceptions.Exception

Base error class for this module.

exceptiongoogle.appengine.api.oauth.OAuthRequestErrorsource

Bases:google.appengine.api.oauth.oauth_api.Error

Base error type for invalid OAuth requests.

exceptiongoogle.appengine.api.oauth.NotAllowedErrorsource

Bases:google.appengine.api.oauth.oauth_api.OAuthRequestError

Raised if the requested URL does not permit OAuth authentication.

exceptiongoogle.appengine.api.oauth.InvalidOAuthParametersErrorsource

Bases:google.appengine.api.oauth.oauth_api.OAuthRequestError

Raised if the request was a malformed OAuth request.

For example, the request may have omitted a required parameter, contained an invalid signature, or was made by an unknown consumer.

exceptiongoogle.appengine.api.oauth.InvalidOAuthTokenErrorsource

Bases:google.appengine.api.oauth.oauth_api.OAuthRequestError

Raised if the request contained an invalid token.

For example, the token may have been revoked by the user.

exceptiongoogle.appengine.api.oauth.OAuthServiceFailureErrorsource

Bases:google.appengine.api.oauth.oauth_api.Error

Raised if there was a problem communicating with the OAuth service.

google.appengine.api.oauth.get_current_user(_scope=None)source

Returns the User on whose behalf the request was made.

Parameters

_scope – The custom OAuth scope or an iterable of scopes at least one of which is accepted.

Returns

User

Raises
google.appengine.api.oauth.is_current_user_admin(_scope=None)source

Returns true if the User on whose behalf the request was made is an admin.

Parameters

_scope – The custom OAuth scope or an iterable of scopes at least one of which is accepted.

Returns

boolean

Raises
google.appengine.api.oauth.get_oauth_consumer_key()source

OAuth1 authentication is deprecated and turned down.

google.appengine.api.oauth.get_client_id(_scope)source

Returns the value of OAuth2 Client ID from an OAuth2 request.

Parameters

_scope – The custom OAuth scope or an iterable of scopes at least one of which is accepted.

Returns

The value of Client ID.

Return type

string

Raises
google.appengine.api.oauth.get_authorized_scopes(scope)source

Returns authorized scopes from input scopes.

Parameters

scope – The custom OAuth scope or an iterable of scopes at least one of which is accepted.

Returns

A list of authorized OAuth2 scopes

Return type

list

Raises

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-16 UTC.