magpie.api.login.login

Module Contents

Functions

process_sign_in_external(request, username, provider)

verify_provider(provider_name: Str) → None

raises HTTPNotFound

if provider name is not one of known providers.

signin_in_param(request)

Signs in a user session using query parameters.

sign_in(request)

Signs in a user session.

login_success_ziggurat(request)

Response from redirect upon successful login with valid user credentials.

login_failure(request, reason=None)

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

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

Create new user with an External Identity.

login_success_external(request: Request, external_user_name: Str, external_id: Str, email: Str, provider_name: Str) → HTTPException

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

authomatic_login(request)

Signs in a user session using an external provider.

sign_out(request)

Signs out the current user session.

get_session(request)

Get information about current session.

get_providers(request)

Get list of login providers.

magpie.api.login.login.LOGGER[source]
magpie.api.login.login.MAGPIE_DEFAULT_PROVIDER[source]
magpie.api.login.login.MAGPIE_INTERNAL_PROVIDERS[source]
magpie.api.login.login.MAGPIE_EXTERNAL_PROVIDERS[source]
magpie.api.login.login.MAGPIE_PROVIDER_KEYS[source]
magpie.api.login.login.process_sign_in_external(request, username, provider)[source]
magpie.api.login.login.verify_provider(provider_name: Str) → None[source]
Raises

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

magpie.api.login.login.signin_in_param(request)[source]

Signs in a user session using query parameters.

magpie.api.login.login.sign_in(request)[source]

Signs in a user session.

magpie.api.login.login.login_success_ziggurat(request)[source]

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

magpie.api.login.login.login_failure(request, reason=None)[source]

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

See also

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

Create new user with an External Identity.

magpie.api.login.login.login_success_external(request: Request, external_user_name: Str, external_id: Str, email: Str, provider_name: Str) → HTTPException[source]

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

magpie.api.login.login.authomatic_login(request)[source]

Signs in a user session using an external provider.

magpie.api.login.login.sign_out(request)[source]

Signs out the current user session.

magpie.api.login.login.get_session(request)[source]

Get information about current session.

magpie.api.login.login.get_providers(request)[source]

Get list of login providers.