users.confirmCredentials

Syntax

mixed users.confirmCredentials ( int vhost, string username, string password, bool returnUserInfo = false, bool login = false, bool isEmail = false, bool isPhone = false, mixed detailedError = false, mixed mfatoken = '' )

Argument Info

Name	Type	Required	Default value	Description
vhost	int	Required	none	The id of the vhost.
username	string	Required	none	The username of the user you are attempting to confirm.
password	string	Required	none	The password for the user you are attempting to confirm.
returnUserInfo	bool	Optional	false	If this parameter is true it will return user info in an array as listed below
login	bool	Optional	false	If this parameter is true it will create a user session token for the user. For this to be available you need to call the method with the returnUserInfo argument set to true.
isEmail	bool	Optional	false	If this parameter is true it will treat the username parameter as an e-mail address instead of a username string.
isPhone	bool	Optional	false	If this parameter is true it will compare the username parameter against the phone number field instead of the username field.
detailedError	mixed	Optional	false
mfatoken	mixed	Optional	''

Response: Optionally returned array

This is the data array that could potentially be returned if returnUserInfo is set to true

Name	Type	Description
id	INT	The user id for the username/email provided.
user	STRING	The username for the account requested.
vhost	INT	The vhost for the account requested.
firstname	STRING	The first name for the account requested.
lastname	STRING	The last name for the account requested.
nickname	STRING	The nickname for the account requested.
address1	STRING	The first line of the address for the account requested.
address2	STRING	The second line of the address for the account requested.
city	STRING	The city for the account requested.
state	STRING	The state/province for the account requested.
country	STRING	The country for the requested account.
postal	STRING	The postal code or zip code for the requested account.
email	STRING	The e-mail address for the requested account.
website	STRING	The website for the requested account.
gender	CHAR	The gender of the requested account owner, obviously this is only going to be M for male or F for female.
phone	STRING	The phone number for the requested account owner.
cellphone	STRING	The cell phone number for the requested account owner.
occupation	STRING	The occupation for the requested account owner.
meta	SERIALIZED ARRAY	An array containing any meta data that was provided by the account owner that has been saved by the system.
newsletter	BOOL	Whether or not the account owner wanted the newsletter or not. 1 is true, 0 is false.

Return Values

Field	Description	Possible Values