magpie.api.login.login

Module Contents

Functions

process_sign_in_external(request, username, provider)
verify_provider(→ None)	Verifies that the specified name is a valid external provider against the login configuration providers.
signin_in_param_view(request)	Signs in a user session using query parameters.
sign_in_view(request)	Signs in a user session.
login_success_ziggurat_view(request)	Response from redirect upon successful login with valid user credentials.
login_failure_view(request[, reason])	Response from redirect upon login failure, either because of invalid or incorrect user credentials.
new_user_external(→ magpie.models.User)	Create new user with an External Identity.
login_success_external(...)	Generates the login response in case of successful external provider identification.
authomatic_login_view(request)	Signs in a user session using an external provider.
sign_out_view(request)	Signs out the current user session.
get_session_view(request)	Get information about current session.
get_providers_view(request)	Get list of login providers.

Attributes

LOGGER
MAGPIE_DEFAULT_PROVIDER
MAGPIE_INTERNAL_PROVIDERS
MAGPIE_EXTERNAL_PROVIDERS
MAGPIE_PROVIDER_KEYS

magpie.api.login.login.LOGGER

magpie.api.login.login.MAGPIE_DEFAULT_PROVIDER

magpie.api.login.login.MAGPIE_INTERNAL_PROVIDERS

magpie.api.login.login.MAGPIE_EXTERNAL_PROVIDERS

magpie.api.login.login.MAGPIE_PROVIDER_KEYS

magpie.api.login.login.process_sign_in_external(request, username, provider)

magpie.api.login.login.verify_provider(provider_name: magpie.typedefs.Str) → None

Verifies that the specified name is a valid external provider against the login configuration providers.

Raises:

HTTPNotFound – if provider name is not one of known providers.

magpie.api.login.login.signin_in_param_view(request)

Signs in a user session using query parameters.

magpie.api.login.login.sign_in_view(request)

Signs in a user session.

magpie.api.login.login.login_success_ziggurat_view(request)

Response from redirect upon successful login with valid user credentials.

Header Set-Cookie from this response will allow creation of the response cookies.

See also

• sign_in()

magpie.api.login.login.login_failure_view(request, reason=None)

Response from redirect upon login failure, either because of invalid or incorrect user credentials.

See also

• sign_in()

magpie.api.login.login.new_user_external(external_user_name: magpie.typedefs.Str, external_id: magpie.typedefs.Str, email: magpie.typedefs.Str, provider_name: magpie.typedefs.Str, db_session: magpie.typedefs.Session) → magpie.models.User

Create new user with an External Identity.

magpie.api.login.login.login_success_external(request: pyramid.request.Request, external_user_name: magpie.typedefs.Str, external_id: magpie.typedefs.Str, email: magpie.typedefs.Str, provider_name: magpie.typedefs.Str) → pyramid.httpexceptions.HTTPException

Generates the login response in case of successful external provider identification.

magpie.api.login.login.authomatic_login_view(request)

Signs in a user session using an external provider.

magpie.api.login.login.sign_out_view(request)

Signs out the current user session.

magpie.api.login.login.get_session_view(request)

Get information about current session.

magpie.api.login.login.get_providers_view(request)

Get list of login providers.