Stay organized with collections Save and categorize content based on your preferences.
google.appengine.api.users module SummaryThe User Python datastore class to be used as a datastore data type.
ContentsComputes the login URL for redirection.
Parametersdest_url – String that is the desired final destination URL for the user once login is complete. If dest_url
does not specify a host, the host from the current request is used.
federated_identity – Decommissioned, don’t use. Setting this to a non-None value raises a NotAllowedError
Login URL as a string. The login URL will use Google Accounts.
RaisesNotAllowedError – If federated_identity is not None.
Computes the logout URL and specified destination URL for the request.
This function works for Google Accounts applications.
Parametersdest_url – String that is the desired final destination URL for the user after the user has logged out. If dest_url
does not specify a host, the host from the current request is used.
Logout URL as a string.
Bases: exceptions.Exception
Base User error type.
Retrieves information associated with the user that is making a request.
Returns:
Specifies whether the user making a request is an application admin.
Because administrator status is not persisted in the datastore, is_current_user_admin()
is a separate function rather than a member function of the User
class. The status only exists for the user making the current request.
True
if the user is an administrator; all other user types return False
.
Bases: object
Provides the email address, nickname, and ID for a user.
A nickname is a human-readable string that uniquely identifies a Google user, akin to a username. For some users, this nickname is an email address, but for other users, a different nickname is used.
A user is a Google Accounts user.
federated_identity
and federated_provider
are decommissioned and should not be used.
Obtains the user’s authentication domain.
ReturnsA string containing the authentication domain. This method is internal and should not be used by client applications.
Returns the user’s email address.
Decommissioned, don’t use.
ReturnsA string containing the federated identity of the user. If the user is not a federated user, None
is returned.
Decommissioned, don’t use.
ReturnsA string containing the federated provider. If the user is not a federated user, None
is returned.
Returns the user’s nickname.
The nickname will be a unique, human readable identifier for this user with respect to this application. It will be an email address for some users, and part of the email address for some users.
ReturnsThe nickname of the user as a string.
Obtains the user ID of the user.
ReturnsA permanent unique identifying string or None
. If the email address was set explicity, this will return None
.
Computes the login URL for redirection.
Parametersdest_url – String that is the desired final destination URL for the user once login is complete. If dest_url
does not specify a host, the host from the current request is used.
federated_identity – Decommissioned, don’t use. Setting this to a non-None value raises a NotAllowedError
Login URL as a string. The login URL will use Google Accounts.
RaisesNotAllowedError – If federated_identity is not None.
Computes the logout URL and specified destination URL for the request.
This function works for Google Accounts applications.
Parametersdest_url – String that is the desired final destination URL for the user after the user has logged out. If dest_url
does not specify a host, the host from the current request is used.
Logout URL as a string.
Retrieves information associated with the user that is making a request.
Returns:
Specifies whether the user making a request is an application admin.
Because administrator status is not persisted in the datastore, is_current_user_admin()
is a separate function rather than a member function of the User
class. The status only exists for the user making the current request.
True
if the user is an administrator; all other user types return False
.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-16 UTC."],[[["This module provides tools for managing user authentication and authorization within Google App Engine applications, using Google Accounts."],["You can generate login URLs to redirect users for authentication and logout URLs to handle user sign-outs, with customizable destination URLs."],["The `User` class provides access to a user's email, nickname, user ID, and authentication domain, but federated identity features are deprecated."],["Functions are available to retrieve information about the current user and determine if they have administrator privileges within the application."],["The module defines several error types for handling issues related to user authentication, such as `NotAllowedError`, `RedirectTooLongError`, and `UserNotFoundError`."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4