UserData Class

Stores user information for Auth.RegistrationHandler.

Namespace

Auth

UserData Constructors

The following are constructors for UserData.

UserData(userId, firstName, lastName, fullName, email, link, userName, locale, provider, siteLoginUrl, attributeMap)

Creates a new instance of the Auth.UserData class using the specified arguments.

Signature

public UserData(String userId, String firstName, String lastName, String fullName, String email, String link, String userName, String locale, String provider, String siteLoginUrl, Map<String,String> attributeMap)

Parameters

userId
Type: String
An identifier from the third party for the authenticated user, such as the Facebook user number or the Salesforce user ID.
firstName
Type: String
The first name of the authenticated user, according to the third party.
lastName
Type: String
The last name of the authenticated user, according to the third party.
fullName
Type: String
The full name of the authenticated user, according to the third party.
email
Type: String
The email address of the authenticated user, according to the third party.
link
Type: String
A stable link for the authenticated user such as https://www.facebook.com/MyUsername.
userName
Type: String
The username of the authenticated user in the third party.
locale
Type: String
The standard locale string for the authenticated user.
provider
Type: String
The service used to log in, such as Facebook or Janrain.
siteLoginUrl
Type: String
The site login page URL passed in if used with a site; null otherwise.
attributeMap
Type: Map<String, String>
A map of data from the third party, in case the handler has to access non-standard values. For example, when using Janrain as a provider, the fields Janrain returns in its accessCredentials dictionary are placed into the attributeMap. These fields vary by provider.

UserData Properties

The following are properties for UserData.

identifier

An identifier from the third party for the authenticated user, such as the Facebook user number or the Salesforce user ID.

Signature

public String identifier {get; set;}

Property Value

Type: String

firstName

The first name of the authenticated user, according to the third party.

Signature

public String firstName {get; set;}

Property Value

Type: String

lastName

The last name of the authenticated user, according to the third party.

Signature

public String lastName {get; set;}

Property Value

Type: String

fullName

The full name of the authenticated user, according to the third party.

Signature

public String fullName {get; set;}

Property Value

Type: String

email

The email address of the authenticated user, according to the third party.

Signature

public String email {get; set;}

Property Value

Type: String

username

The username of the authenticated user in the third party.

Signature

public String username {get; set;}

Property Value

Type: String

locale

The standard locale string for the authenticated user.

Signature

public String locale {get; set;}

Property Value

Type: String

provider

The service used to log in, such as Facebook or Janrain.

Signature

public String provider {get; set;}

Property Value

Type: String

siteLoginUrl

The site login page URL passed in if used with a site; null otherwise.

Signature

public String siteLoginUrl {get; set;}

Property Value

Type: String

attributeMap

A map of data from the third party, in case the handler has to access non-standard values. For example, when using Janrain as a provider, the fields Janrain returns in its accessCredentials dictionary are placed into the attributeMap. These fields vary by provider.

Signature

public Map<String, String> attributeMap {get; set;}

Property Value

Type: Map<String, String>