JAuthenticationResponse

Authentication response class, provides an object for storing user and error details

since

11.1

package

Joomla.Platform

Methods

Properties

status

Response status (see status codes)

Type(s)

string

type

The type of authentication that was successful

Type(s)

string

error_message

The error message

Type(s)

string

username

Any UTF-8 string that the End User wants to use as a username.

Type(s)

string

password

Any UTF-8 string that the End User wants to use as a password.

Type(s)

string

email

The email address of the End User as specified in section 3.4.1 of [RFC2822]

Type(s)

string

fullname

UTF-8 string free text representation of the End User's full name.

Type(s)

string

birthdate

The End User's date of birth as YYYY-MM-DD. Any values whose representation uses fewer than the specified number of digits should be zero-padded. The length of this value MUST always be 10. If the End User user does not want to reveal any particular component of this value, it MUST be set to zero.

For instance, if an End User wants to specify that their date of birth is in 1980, but not the month or day, the value returned SHALL be "1980-00-00".

Type(s)

string

gender

The End User's gender, "M" for male, "F" for female.

Type(s)

string

postcode

UTF-8 string free text that SHOULD conform to the End User's country's postal system.

Type(s)

string

country

The End User's country of residence as specified by ISO3166.

Type(s)

string

language

End User's preferred language as specified by ISO639.

Type(s)

string

timezone

ASCII string from TimeZone database

Type(s)

string