google.appengine.api.oauth.oauth_api モジュール

概要

OAuth API。

App Engine アプリで OAuth リクエストを検証できるようにするサービス。

ここで以下のクラスを定義します。

エラー: 基本の例外型 NotAllowedError: OAuthService 例外 OAuthRequestError: OAuthService 例外 InvalidOAuthParametersError: OAuthService 例外 InvalidOAuthTokenError: OAuthService 例外 OAuthServiceFailureError: OAuthService 例外

内容

例外 google.appengine.api.oauth.oauth_api.Errorソース

ベース: exceptions.Exception

このモジュールのベースエラー クラス。

例外 google.appengine.api.oauth.oauth_api.InvalidOAuthParametersErrorソース

ベース: google.appengine.api.oauth.oauth_api.OAuthRequestError

リクエストが不正な OAuth リクエストであった場合に発生します。

たとえば、リクエストに必要なパラメータが省略されている、無効なシグネチャが含まれている、未知のコンシューマが作成したリクエストなどの場合です。

例外 google.appengine.api.oauth.oauth_api.InvalidOAuthTokenErrorソース

ベース: google.appengine.api.oauth.oauth_api.OAuthRequestError

リクエストに無効なトークンが含まれている場合に発生します。

たとえば、ユーザーがトークンを取り消した可能性があります。

例外 google.appengine.api.oauth.oauth_api.NotAllowedErrorソース

ベース: google.appengine.api.oauth.oauth_api.OAuthRequestError

リクエストされた URL では OAuth 認証が許可されない場合に発生します。

例外 google.appengine.api.oauth.oauth_api.OAuthRequestErrorソース

ベース: google.appengine.api.oauth.oauth_api.Error

無効な OAuth リクエストのベースエラー型。

例外 google.appengine.api.oauth.oauth_api.OAuthServiceFailureErrorソース

ベース: google.appengine.api.oauth.oauth_api.Error

OAuth サービスとの通信中に問題が生じた場合に発生します。

google.appengine.api.oauth.oauth_api.get_authorized_scopes(scope)ソース

入力スコープから、承認されたスコープを返します。

パラメータ

scope - カスタム OAuth スコープ、または少なくとも 1 つが受け入れられるスコープの反復。

戻り値

承認された OAuth2 スコープのリスト

戻り値の型

list

発生
google.appengine.api.oauth.oauth_api.get_client_id(_scope)ソース

OAuth2 リクエストから OAuth2 クライアント ID の値を返します。

パラメータ

scope - カスタム OAuth スコープ、または少なくとも 1 つが受け入れられるスコープの反復。

戻り値

クライアント ID の値。

戻り値の型

string

発生
google.appengine.api.oauth.oauth_api.get_current_user(_scope=None)ソース

ユーザーの代理として行われたリクエストについて、そのユーザーを返します。

パラメータ

scope - カスタム OAuth スコープ、または少なくとも 1 つが受け入れられるスコープの反復。

戻り値

User

発生
google.appengine.api.oauth.oauth_api.get_oauth_consumer_key()ソース

OAuth1 認証は推奨されなくなったため、使用できません。

google.appengine.api.oauth.oauth_api.is_current_user_admin(_scope=None)ソース

ユーザーの代理として行われたリクエストについて、そのユーザーが管理者である場合は true を返します。

パラメータ

scope - カスタム OAuth スコープ、または少なくとも 1 つが受け入れられるスコープの反復。

戻り値

ブール値

発生
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Python の App Engine スタンダード環境