actions/auth

Community Actions Channel

Parameters:
Name Type Description
config Object
services Object
emit function
Returns:
Type
function

Methods

(inner) changePassword(params) → {Boolean}

change the password for an account

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
password String
newpassword String
code String <optional>
Returns:
Type
Boolean

(inner) isPasswordValid(params) → {Boolean}

validate password validity

Parameters:
Name Type Description
params Object
Properties
Name Type Description
password String
Returns:
Type
Boolean

(inner) login(params) → {Object}

login an account

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
email String
password String
code String <optional>
Returns:

user details

Type
Object

(inner) requestNewsletterSubscription(params) → {Boolean}

request verification email to subscribe to the newsletter

Parameters:
Name Type Description
params Object
Properties
Name Type Description
email String
Returns:
Type
Boolean

(inner) requestPasswordChange(params) → {Boolean}

request email to change password

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
email String
code String <optional>
Returns:
Type
Boolean

(inner) requestResetEmail(params) → {Boolean}

request to change email associated with the account

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
email String
code String <optional>
Returns:
Type
Boolean

(inner) resetEmail(params) → {Boolean}

forcefully change email associated with a account

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
email String
newEmail String
password String
code String <optional>
Returns:
Type
Boolean

(inner) setNewPassword(params) → {Boolean}

forcefully change password for a account

Parameters:
Name Type Description
params Object
Properties
Name Type Description
tokenid String
newpassword String
Returns:
Type
Boolean

(inner) signup(params) → {Object}

create a new account

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
email String
password String
username String
birthday String
newsletter Boolean <optional>
referrer String <optional>
captcha String
Returns:

user details

Type
Object

(inner) twoFactorEnabled(params) → {Boolean}

check if twofactor is enable for the given email

Parameters:
Name Type Description
params Object
Properties
Name Type Description
token String
Returns:
Type
Boolean

(inner) validateUsername(params) → {Boolean}

validate username availability

Parameters:
Name Type Description
params Object
Properties
Name Type Description
username String
Returns:
Type
Boolean

(inner) verifyEmail(params) → {Boolean}

process email verification token

Parameters:
Name Type Description
params Object
Properties
Name Type Description
tokenid String
Returns:
Type
Boolean

(inner) verifyResetEmail(params) → {Boolean}

process email change request

Parameters:
Name Type Description
params Object
Properties
Name Type Description
tokenid String
email String
Returns:
Type
Boolean