AuthenticationResponse
Authentication response class, provides an object for storing user and error details
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Properties
status
Response status (see status codes)
| since |
1.7.0 |
|---|
Type(s)
string
type
The type of authentication that was successful
| since |
1.7.0 |
|---|
Type(s)
string
error_message
The error message
| since |
1.7.0 |
|---|
Type(s)
string
username
Any UTF-8 string that the End User wants to use as a username.
| since |
1.7.0 |
|---|
Type(s)
string
password
Any UTF-8 string that the End User wants to use as a password.
| since |
1.7.0 |
|---|
Type(s)
string
The email address of the End User as specified in section 3.4.1 of [RFC2822]
| since |
1.7.0 |
|---|
Type(s)
string
fullname
UTF-8 string free text representation of the End User's full name.
| since |
1.7.0 |
|---|
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".
| since |
1.7.0 |
|---|
Type(s)
string
gender
The End User's gender, "M" for male, "F" for female.
| since |
1.7.0 |
|---|
Type(s)
string
postcode
UTF-8 string free text that SHOULD conform to the End User's country's postal system.
| since |
1.7.0 |
|---|
Type(s)
string
country
The End User's country of residence as specified by ISO3166.
| since |
1.7.0 |
|---|
Type(s)
string
language
End User's preferred language as specified by ISO639.
| since |
1.7.0 |
|---|
Type(s)
string
timezone
ASCII string from TimeZone database
| since |
1.7.0 |
|---|
Type(s)
string