English ▼
Skip to page content Skip to main navigation
e.g. "templates" or "datastore"

# Functions

The `google.appengine.api.users` package provides the following functions:

create_login_url(dest_url=None, _auth_domain=None, federated_identity=None)

  Returns a URL that, when visited, prompts the user to sign in using the current authentication option, then redirects the user back to the URL given as dest_url. This URL is suitable for links, buttons and redirects.

  dest_url can be full URL or a path relative to your application's domain.

  _auth_domain is ignored.

  federated_identity is the user's OpenID identifier. If the application is not configured for OpenID, this parameter is ignored. If the application is configured for OpenID, the resulting login URL redirects the user to log in using OpenID. Note that the OpenId identifier can be any identifier which is discoverable using OpenId protocol. If the parameter is not specified, URL redirects the user to log in with OpenID using the Google OpenID sign-in page.
  This parameter is specified as a keyword argument, e.g. `create_login_url(destination_url, federated_identity=requested_identity)`

create_logout_url(dest_url)

  Returns a URL that, when visited, signs the user out, then redirects the user back to the URL given as dest_url. This URL is suitable for links, buttons and redirects.

  dest_url can be full URL or a path relative to your application's domain.

get_current_user()

  Returns the User object for the current user (the user who made the request being processed) if the user is signed in, or `None` if the user is not signed in.

is_current_user_admin()

  Returns `True` if the current user is signed in and is currently registered as an administrator of this application.