Identity Structure

Identities represent collections of user information. Each identity is uniquely identified by an identity_token and belongs to a single user identified by a user_token.

Identity Creation

Identities created from Social Network Profiles

Identities are created automatically when users authenticate with their social network accounts using a OneAll service like for example Social Login. In this case the social network profile data is normalized and stored as identity. Depending on the social network, more or less information is available.

Identities created using the Cloud Storage API

Identities can also be created manually by using our User Cloud Storage API. In this case the identity contains the user information that has been pushed to the cloud storage.

Identity Format

Identites are used in many endpoints of the OneAll API and always have the following format:

"identity": {
	   "identity_token": "#identity_token#",
	   "provider": "#provider#",
	   "name": {            
	      "honorificPrefix": "#honorificPrefix#",
	      "givenName": "#givenName#",
	      "middleName": "#middleName#",
	      "familyName": "#familyName#"      
	      "honorificSuffix": "#honorificSuffix#",    
	      "formatted": "#formatted#"
	   },
	   "preferredUsername": "#preferredUsername#",
	   "displayName": "#displayName#",
	   "profileUrl": "#profileUrl#",
	   "thumbnailUrl": "#thumbnailUrl#",
	   "currentLocation": "#currentLocation#",
	   "aboutMe": "#aboutMe#",
	   "note": "#note#",
	   "birthday": "#birthday#",
	   "gender": "#gender#",
	   "utcOffset": "#utcOffset#",
	   "roles": [
	      {
	         "value": "#value#"
	      }
	   ],
	   "relationship": {
	         "status": "#status#",
	         "interested_in": "#interestedIn#"
	   },
	   "emails": [
	      {
	         "value": "#value#",
	         "is_verified": "#isVerified#"
	      }
	   ],         
	   "urls": [
	      {
	         "value": "#value#",
	         "type": "#type#"
	      }
	   ],
	   "accounts": [
	      {
	         "domain": "#domain#",
	         "userid": "#userid#"
	      }
	   ],
	   "photos": [
	      {
	         "value": "#value#",
	         "size": "#size#"
	      }
	   ],
	   "languages": [
	      {
	         "value": "#value#"
	         "proficiency": "#proficiency#"
	         "description": "#description#"
	      }
	   ],
	   "locales": [
	      {
	         "value": "#value#"
	         "description": "#description#"
	      }
	   ],
	   "interests": [
	      {
	         "value": "#value#",
	         "category": "#category#"
	      }
	   ],         
	  "likes": [
	      {
	         "value": "#value#",
	         "group": "#group#",
	         "category": "#category#",
	         "link": "#link#"               
	      }
	   ],
	   "addresses": [
	      {
	      	 "type": "#type#",
	       	 "companyName": "#companyName#",
	       	 "firstName": "#firstName#",
	       	 "middleName": "#middleName#",
	       	 "lastName": "#lastName#",
	       	 "phoneNumber": "#phoneNumber#",
	         "faxNumber": "#faxNumber#",
	         "streetAddress": "#streetAddress#",
	         "complement": "#complement#",
	         "locality": "#locality#",
	         "region": "#region#",
	         "postalCode": "#postalCode#",
	         "code": "#code#"
	         "country": "#country#"
	         "formatted": "#formatted#"
	      }
	   ],   
	   "phoneNumbers": [
	      {
	         "value": "#phones_value#",
	         "type": "#phones_type#"
	      }
	   ],      
	   "educations": [
	      {
	         "value": "#value#",
	         "type": "#type#"
	      }
	   ],
	   "organizations": [
	      {
	         "name": "#name#",
	         "location": "#location#",
	         "industry": "#industry#",               
	         "title": "#title#",
	         "description": "#description#",
	         "department": "#department#",
	         "startDate": "#startDate#",
	         "endDate": "#endDate#"
	      }
	   ]        
	}
Node Description
identity_token (single value)
#identity_token#
string, automatically generated, readonly
Unique identifier of this identity
Example: b464fa35-905a-4005-96dd-c3c94eff3ab9
provider (single value)
#provider#
string, automatically generated, readonly
Source of this identity (Facebook, Twitter, Cloud)
Example: Facebook
name (object)
#honorificSuffix#
string
Honorifix suffix(es)
Example: Mr.
#givenName#
string
First Name
Example: John
#middleName#
string
Middle Name
Example: Junior
#familyName#
string
Last Name
Example: Doe
#honorificSuffix#
string
Honorifix suffix(es)
Example: Esq.
#formatted#
derived property
Full name as formatted string
Example: Mr. John Junior Doe, Esq.
preferredUsername (single value)
#preferredUsername#
string
Preferred Username
Example: john.doe
displayName (single value)
#displayName#
string
Handle to easily identify the user
Example: John
profileUrl (single value)
#profileUrl#
string: url
Link to the user's profile page
Example: https://www.example.com/johns-profile.html
thumbnailUrl (single value)
#thumbnailUrl#
string: url
Link to a small user picture
Example: https://www.example.com/johns-thumbnail.png
currentLocation (single value)
#currentLocation#
string
User location
Example: New York City
aboutMe (single value)
#aboutMe#
string
User Information
Example: John is a professor of Biology at the University of California.
note (single value)
#note#
string
User Notes
Example: John is an official sponsor of our club.
birthday (single value)
#birthday#
string: mm/dd/yyyy
User birthday
Example: 12/31/1965
gender (single value)
#gender#
string: male, female
User Gender
Example: male
utcOffset (single value)
#utcOffset#
string
UTC offset of the user's timezone
Example: -2:00
roles (object list)
#value#
string
User Role
Example: admin
relationship (object)
#status#
string
The status of the user's relationship
Example: married
#interestedIn#
string
What gender the user is attracted to
Example: female
emails (object list)
#value#
string: email address
The user's email address
Example: john.doe@example.com
#isVerified#
boolean: true, false
Whether this email address has been verified to belong to the user or not (true/false)
Example: true
urls (object list)
#value#
string: url
An url related to this user
Example: https://www.johns-blog.com
#type#
string: work, home, blog, profile, personal
The type of the url
Example: blog
accounts (object list)
#domain#
string: domain name
The domain where the account has been created
Example: facebook.com
#userid#
string
The identifier of the account
Example: 12312412344
#username#
string
The username of the account
Example: johndoe
photos (object list)
#value#
string: url
Link to a user photo
Example: http://www.example.com/johns-photo.png
#size#
string: xxs, xs, s, m, l, xl, xxl
Size of the user photo
Example: xs
languages (object list)
#value#
string
Language title
Example: English
#proficiency#
string: A1, A2, B1, B2, C1, C2
CEFR language proficiency
Example: A1
#description#
derived property
Language proficiency description
Example: Breakthrough or beginner
locales (object list)
#value#
string
Locale value
Example: en_US
#description#
string
Locale description
Example: English (United States)
interests (object list)
#value#
string
User interest
Example: The Lord of the Rings
#category#
string
Category of interest
Example: Fantasy Novel
likes (object list)
#value#
string
User Like
Example: Nirvana
#type#
string: movies, games, books, music, television
User Like Type
Example: music
#category#
string
User Like Category
Example: Musician/Band
#link#
string: url
User Like Link
Example: http://www.nirvana.com/
addresses (object list)
#type#
string
Address, Type
Example: Shipping
#companyName#
string
Address, Company Name
Example: OneAll
#firstName#
string
Address, First Name
Example: John
#middleName#
string
Address, Middle Name
Example: John
#lastName#
string
Address, Last Name
Example: Doe
#phoneNumber#
string
Address, Phone Number
Example: 001 555 111 1111
#faxNumber#
string
Address, Fax Number
Example: 001 555 111 2222
#streetAddress#
string
Address, Street
Example: 1234 Brooklyn Street
#complement#
string
Address, Complement
Example: Apartment 27
#locality#
string
Address, City
Example: Dallas
#region#
string
Address, State or Region
Example: TX
#postalCode#
string
Address, Zip/Postal Code
Example: 75201
#code#
string
Address, Country Code
Example: USA
#country#
derived property
Address, Country Name
Example: United States of America
#formatted#
derived property
Address, Formatted
Example: 1234 Brooklyn Street, Dallas, TX 75201, United States of America (USA)
phoneNumbers (object list)
#value#
strong
Phone Number
Example: 001 555 111 1111
#type#
work, home, mobile, fax, pager
Phone Type
Example: work
educations (object list)
#value#
string
Education Establishment
Example: Princeton, NJ
#type#
string
Establishment Type
Example: University
organizations (object list)
#name#
string
Company Name
Example: OneAll, Inc
#location#
string
Company Location
Example: Europe (Luxembourg)
#industry#
string
Company Industry
Example: Software as a service
#title#
string
Job Title
Example: Developer
#description#
string
Job Description
Example: Coding and debugging
#department#
string
Job Department
Example: Information Technology
#startDate#
string: yyyy, mm/yyyy
Job Start Date
Example: 01/2010
#endDate#
string: yyyy, mm/yyyy
Job End Date
Example: 12/2010

User Contributed Notes