JSON structure that represents all info related with a DRUID user. The structure is definde according Activity Strems Schema definition, more info there.
| Attribute | Description | Required | Value |
|---|---|---|---|
| id | User internal identifier | yes | string |
| objectType | ObjectType representing the user | yes | ‘user’ |
| createdOn | Date when user was created | yes | timestamp |
| app_id | App identifier where the user was registered | yes | string |
| entrypoint_id | Entrypoint identifier where the user was registered | yes | string |
| confirmed | Confirmed status of the user: if true, user has confirmed at least one identifier, so we know that is a ‘real’ person | yes | boolean |
| ids | Dynamic list of user identifiers (more undocumented identified could be retrieved) | yes (at least one identifier is mandatory) | array |
| ids.national_id | Struct that defines national id of user | no | struct |
| ids.national_id.objectType | Type of element | yes | ‘user_id’ |
| ids.national_id.displayName | Identifier name | no | string |
| ids.national_id.value | National id value | yes | string |
| ids.national_id.confirmed | User has confirmed that really is the owner of national id | no | boolean |
| ids.phone_number | Struct that defines mobile number of user | no | struct |
| ids.phone_number.objectType | Type of element | yes | ‘user_id’ |
| ids.phone_number.displayName | Identifier name | no | string |
| ids.phone_number.value | Mobile number of user | yes | string |
| ids.phone_number.confirmed | User has confirmed that really is the owner of mobile number (via SMS/MMS) | no | boolean |
| ids.screen_name | Struct that defines screen name of user (aka nick) | no | struct |
| ids.screen_name.objectType | Type of element | yes | ‘user_id’ |
| ids.screen_name.displayName | Identifier name | no | string |
| ids.screen_name.value | Screen name of user | yes | string |
| ids.screen_name.confirmed | User has confirmed that really is the owner of screen name | no | boolean |
| ids.email | Struct that defines email of user | no | struct |
| ids.email.objectType | Type of element | yes | ‘user_id’ |
| ids.email.displayName | Identifier name | no | string |
| ids.email.value | Email of user | yes | ^([_A-Za-z0-9-+]+(.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(.[A-Za-z0-9]+)*(.[A-Za-z]{2,}))$ |
| ids.email.confirmed | User has confirmed that really is the owner of email (via email) | no | boolean |
| datas | Dynamic list of user datas (more undocumented identified could be retrieved) | no | array |
| datas.birthday | Struct that defines birthday os user | no | struct |
| datas.birthday.objectType | Type of element | yes | ‘user_data’ |
| datas.birthday.displayName | Data name | no | string |
| datas.birthday.value | Bithday of user | yes | dd/mm/yyyy |
| datas.twitter | Struct that defines twitter of user | no | struct |
| datas.twitter.objectType | Type of element | yes | ‘user_data’ |
| datas.twitter.displayName | Data name | no | string |
| datas.twitter.value | Twitter of user | yes | @string |
| datas.gender | Struct that defines the gender of user | no | struct |
| datas.gender.objectType | Type of element | yes | ‘user_data’ |
| datas.gender.displayName | Data name | no | string |
| datas.gender.value | Gender of user | yes | ‘1’ (Female) | ‘2’ (Male) |
| datas.other_email | Struct that defines another and unconfirmed user email | no | struct |
| datas.other_email.objectType | Type of element | yes | ‘user_data’ |
| datas.other_email.displayName | Data name | no | string |
| datas.other_email.value | User’s another email | yes | ^([_A-Za-z0-9-+]+(.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(.[A-Za-z0-9]+)*(.[A-Za-z]{2,}))$ |
| datas.company | Struct that defines company of user | no | struct |
| datas.company.objectType | Type of element | yes | ‘user_data’ |
| datas.company.displayName | Data name | no | string |
| datas.company.value | Company name of the user | yes | string |
| datas.company.publicCompany | If is public company | yes | boolean |
| datas.company.fax | Company fax of the user | no | string |
| datas.company.phone | Company phone of the user | no | string |
| datas.position | Struct that defines position of user | no | struct |
| datas.position.objectType | Type of element | yes | ‘user_data’ |
| datas.position.displayName | Data name | no | string |
| datas.position.value | Position of the user | yes | string |
| datas.geo_scope | Struct that defines geo scope of user position | no | struct |
| datas.geo_scope.objectType | Type of element | yes | ‘user_data’ |
| datas.geo_scope.displayName | Data name | no | string |
| datas.geo_scope.value | User’s position geo scope | yes | ‘1’ (Global) | ‘2’ (European) | ‘3’ (National) | ‘4’ (Regional) | ‘5’ (Local) |
| datas.phone | Struct that defines non mobile phone of user | no | struct |
| datas.phone.objectType | Type of element | yes | ‘user_data’ |
| datas.phone.value | Non mobile phone of user | no | string |
| datas.phone.displayName | Data name | no | string |
| datas.web | Struct that defines web url of user | no | struct |
| datas.web.objectType | Type of element | yes | ‘user_data’ |
| datas.web.displayName | Data name | no | string |
| datas.web.value | Web url of user | yes | string |
| datas.surname | Struct that defines surname of user | no | struct |
| datas.surname.objectType | Type of element | yes | ‘user_data’ |
| datas.surname.displayName | Data name | no | string |
| datas.surname.value | Surname of user | yes | string |
| datas.name | Struct that defines name of user | no | struct |
| datas.name.objectType | Type of element | yes | ‘user_data’ |
| datas.name.displayName | Data name | no | string |
| datas.name.value | Name of user | yes | string |
| datas.fax | Struct that defines fax of user | no | struct |
| datas.fax.objectType | Type of element | yes | ‘user_data’ |
| datas.fax.displayName | Data name | no | string |
| datas.fax.value | Fax of the user | yes | string |
| datas.blog | Struct that defines blog url of user | no | struct |
| datas.blog.objectType | Type of element | yes | ‘user_data’ |
| datas.blog.displayName | Data name | no | string |
| datas.blog.value | Blog url of the user | yes | string |
| datas.other_phone | Struct that defines other phone of user | no | struct |
| datas.other_phone.objectType | Type of element | yes | ‘user_data’ |
| datas.other_phone.displayName | Data name | no | string |
| datas.other_phone.value | Other phone of the user | yes | string |
| assertions | Struct that defines legalities manage by the user | yes | struct |
| assertions.items | Array of assertions | yes | array |
| assertions.items.objectType | Type of element | yes | ‘assertion’ |
| assertions.items.type | Type of assertion | yes | string |
| assertions.items.typology | Assertion typololgy reference | yes | string |
| assertions.items.mandatory | Define if assertion is mandatory: user MUST accept assertions that are mandatory | yes | boolean |
| assertions.items.value | Assertion value for the user | yes | boolean |
| assertions.totalItems | Number os assertions manage by the user | yes | int |
| typologies | User typologies assigned | yes | array string |
| location | Location data of the user | no | struct |
| location.objectType | Type of element | yes | ‘place’ |
| location.address | A physical address of the location | yes | struct |
| location.address.streetAddress | The street address including house number, street name, P.O. Box, and extended multi-line address information | yes | string |
| location.address.locality | The city or locality | yes | string |
| location.address.region | The id of state or region | yes | string |
| location.address.postalCode | The zip or postal code | yes | string |
| location.address.country | The country iso code | yes | string |
| objectId | User ID auto generated by DRUID. Its neccesary to refer to this user in API calls | yes | string |