klein.interfaces.ISimpleAccountBinding

interface documentation

class ISimpleAccountBinding(Interface): (source)

Data-store agnostic account / session binding manipulation API for "simple" accounts - i.e. those using username, password, and email address as a method to authenticate a user.

This goes into a user-authentication-capable ISession object's data attribute as a component.

Method	`bindIfCredentialsMatch`	Attach the session this is a component of to an account with the given username and password, if the given username and password correctly authenticate a principal.
Method	`boundAccounts`	Retrieve the accounts currently associated with the session this is a component of.
Method	`createAccount`	Create a new account with the given username, email and password.
Method	`unbindThisSession`	Disassociate the session this is a component of from any accounts it's logged in to.

def bindIfCredentialsMatch(username, password): (source)

Attach the session this is a component of to an account with the given username and password, if the given username and password correctly authenticate a principal.

Parameters
username:`str`	Undocumented
password:`str`	Undocumented

def boundAccounts(): (source)

Retrieve the accounts currently associated with the session this is a component of.

Returns
`Deferred`	`Deferred` firing with a `list` of `ISimpleAccount`.

def createAccount(username, email, password): (source)

Create a new account with the given username, email and password.

Parameters
username:`str`	Undocumented
email:`str`	Undocumented
password:`str`	Undocumented

def unbindThisSession(): (source)

Disassociate the session this is a component of from any accounts it's logged in to.