パッケージ google.golang.org/appengine/user（v1.6.8）

User パッケージは、App Engine のユーザー認証サービス用のクライアントを提供します。

関数

func IsAdmin

func IsAdmin(c context.Context) bool

現在のユーザーがログインし、アプリケーションの管理者として登録されている場合、IsAdmin は true を返します。

func LoginURL

func LoginURL(c context.Context, dest string) (string, error)

URL が閲覧されると、LoginURL はその URL を返し、ユーザーにログインを促します。ログイン後、宛先で指定された URL にユーザーをリダイレクトします。

func LoginURLFederated

func LoginURLFederated(c context.Context, dest, identity string) (string, error)

LoginURLFederated は LoginURL に似ていますが、ユーザーの OpenID 識別子を受け入れます。

func LogoutURL

func LogoutURL(c context.Context, dest string) (string, error)

URL が閲覧されると、LogoutURL が URL を返します。ユーザーをログアウトして、宛先に指定された URL にリダイレクトします。

func OAuthConsumerKey

func OAuthConsumerKey(c context.Context) (string, error)

OAuthConsumerKey は、現在のリクエストで提供される OAuth コンシューマ キーを返します。OAuth リクエストが無効な場合、メソッドはエラーを返しします。

User

type User struct {
	Email      string
	AuthDomain string
	Admin      bool

	// ID is the unique permanent ID of the user.
	// It is populated if the Email is associated
	// with a Google account, or empty otherwise.
	ID string

	// ClientID is the ID of the pre-registered client so its identity can be verified.
	// See https://developers.google.com/console/help/#generatingoauth2 for more information.
	ClientID string

	FederatedIdentity string
	FederatedProvider string
}

User は、アプリケーションのユーザーを表します。

func Current

func Current(c context.Context) *User

Current は、現在のログイン ユーザーを返します。ユーザーがログインしていない場合は nil を返します。

func CurrentOAuth

func CurrentOAuth(c context.Context, scopes string) (*User, error)

CurrentOAuth は、このリクエストを送信した OAuth コンシューマに関連するユーザーを返します。OAuth コンシューマが有効な OAuth リクエストを送信していない場合や、スコープが空でなく現在のユーザーに 1 つ以上のスコープが設定されていない場合、このメソッドはエラーを返します。

func (*User) String

func (u *User) String() string

String は、ユーザーに表示可能な名前を返します。