Identity Structure

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#"
	      }
	   ]        
	}