Description
This object represents a person's identity on a specific provider. A distinct Identity object is produced per each connected provider.
Note: Different providers supply different data. Thus, the availability of the data members of the Identity object depends on the specific provider.
Data Members
| Field Name | Type | Description |
| provider | string | The name of the connected provider for this identity, in lowercase letters ("facebook", "yahoo", etc.). |
| providerUID | string | The user ID provided by the connected provider. For Facebook this is an application-scoped ID, in which case a user can have more than one providerUID. The 'mappedProviderUIDs' array contains all of the provider UIDs mapped to the user. Note: This field may be rather long for some providers; if you plan to store it in a DB the recommended field size is 300 characters. |
| providerUIDSig | string | This field is available only if the signIDs field of the global configuration object was set to 'true'. The providerUIDSig field holds the HMAC-SHA1 hash of following string: "<timestamp>_<provider>_<providerUID>", where <timestamp>, <provider>, <providerUID> are substituted with the corresponding values. |
| mappedProviderUIDs | array of objects | An array holding all the provider UIDs mapped to the user and the API keys associated with each provider UID. { |
| isLoginIdentity | Boolean | Indicates whether this identity was the one that the user used in order to login. |
| nickname | string | The person's nickname, this may be either the nickname provided by the connected provider or a concatenation of first and last name. |
| allowsLogin | Boolean | Indicates whether the user may use this identity for logging in to your site. |
| isExpiredSession | Boolean | Indicates whether the session has expired for this provider (or is otherwise inactive). This field is relevant and available only if when calling the getUserInfo method you have set the includeAllIdentities parameter to 'true'. |
| lastLoginTime | number | The time of the user's last login in Unix time format (i.e., the number of seconds since Jan. 1st 1970). |
| photoURL | string | The URL of the person's full size photo. |
| thumbnailURL | string | The URL of the person's thumbnail photo, if available. |
| firstName | string | The person's first name. |
| lastName | string | The person's last name. |
| gender | string | The person's gender. The value may be 'm', 'f', or 'u' for male, female, or unspecified. |
| age | number | The person's age. |
| birthDay | number | The day of the month in which the person was born. |
| birthMonth | number | The month in which the person was born. |
| birthYear | number | The year in which the person was born. |
| string | The person's email. | |
| country | string | The person's country. |
| state | string | The person's state. |
| city | string | The person's city. |
| zip | string | The person's zip code. |
| profileURL | string | The URL of the person's profile. |
| languages | string | A comma-separated list of languages that the person speaks. |
| address | string | The person's address. |
| phones | array of objects | The person's phone numbers. |
| education | array of objects | The person's education details. |
| honors | string | A comma-separated list of the person's honors. |
| publications | array of objects | The person's publications' details. |
| patents | array of objects | The person's patents' details. |
| certifications | array of objects | The person's certifications' details. |
| professionalHeadline | string | The person's professional headline, often the job title at their company. |
| bio | string | A description of the person's professional profile. |
| industry | string | The industry in which the person's company operates. |
| specialties | string | The person's specialties. |
| work | array of objects | A collection of the person's work experience. |
| skills | array of objects | A collection of the person's skills. |
| religion | string | The person's religion. |
| politicalView | string | The person's political views. |
| interestedIn | string | The gender in which the person is interested. |
| relationshipStatus | string | The relationship status of the person. |
| hometown | string | The person's hometown. |
| favorites | JSON object | The person's favorite things, including favorite books, movies, etc. |
| likes | array of objects | Retrieves up to 500 of the person's Facebook likes. |
| followersCount | integer | The number of other users following this user, when applicable (Twitter). |
| followingCount | integer | The number of users this user is following, when applicable (Twitter). |
| username | string | The person's Facebook user name. |
| locale | string | The person's locale. |
| verified | Boolean | Indicates whether the person verified his email with Facebook. |
| timezone | string | The person's timezone. |
| missingPermissions | string | A comma-separated string that lists the differences between the general capabilities of Facebook and the requested capabilities. The requested capabilities are the ones checked in the console permissions, e.g., "missingPermissions": "Actions, Status, Photos". |
| samlData | JSON object | Custom SAML data. When mapping IdP attributes to identity fields, we allow mapping to a custom identity field, not only to an existing one. An attribute can be mapped to this custom identity field by mapping it to a name like "samlData.myField". In cases where a SAML attribute has multiple instances and/or multiple values, all values from all instances will be collected into a JSON array. Here is an example of how this attribute will be stored in the identity object: "samlData": { "eduPersonScopedAffiliation": [ "Member@testshib.org", "Staff@testshib.org" ] } |
| proxiedEmail | | Deprecated. |