The Account Object represents a user account within an Organization.
_id ObjectId | The account identifier. |
access | The current caller's context access level. |
activationRequired | True if the account must be activated before use. Dependant on Org settings. |
age | The age of the account holder (based on the dob property). |
connections | Connections associated with the Account. |
created | The date the context was created. |
dob | Account holder date of birth. |
email* | The email address for the account and must be unique within the Org. |
favorite | Tags the context as a favorite, which can then be filtered using the API. |
gender | Account holder gender. Available values are: |
image | The account profile image. |
inherited_roles | Any roles that are inherited from my current role. If my current role has no sub-roles then this is an empty array. |
key | A fingerprint and secret, re-generated on password change. Useful for client-side PHI encryption/caching scenarios, it is available to the account holder for the life of an authenticated session. |
mobile | The mobile number of the account holder. This number should be capable of receiving SMS messages and must be in E.164 format. |
name | Name of the account holder (split into first and last names as well as optional prefix, middle, suffix and additional[]). |
object | The context’s object name. |
preferences | The account preferences. |
profile | The account profile. |
roles | Account roles (e.g. Provider, Administrator, Developer). Accounts can have more than one role. |
shared | True if there are any active or pending connections for this context. |
state | Current state for the account. (e.g. unverified, verified) |
tz | Timezone for the account. This helps determine UTC offset when working in scripts. The timezone must by a unique identifier for an IANA assigned zone, e.g. "US/Pacific" |
updated | The date the latest update was made to a context’s properties |
updater | The account id of the context updater |
{
"_id": "54c66edac364f2201b78c34e",
"access": 6,
"dob": "1975-01-26",
"email": "[email protected]",
"favorite": false,
"gender": "m",
"key": {
"fingerprint": "094be6f0-a57b-11e4-9323-d35446f5af36",
"secret": "P07uqKLlXDWjj3s85TGJt4BXSuSCFlpx"
},
"locale": "en_US",
"locked": false,
"mobile": "15551234567",
"name": {
"first": "John",
"last": "Smith"
},
"object": "account",
"preferences": {
"notifications": [
{
"label": "Custom Notifier",
"name": "c_notifier",
"_id": "56cbfddcba9ef5257bf48513",
"endpoints": [
{
"_id": "456e64706f696e7420536d73",
"enabled": false,
"label": "SMS",
"name": "sms"
},
{
"_id": "456e64706f696e7420456d6c",
"enabled": true,
"label": "Email",
"name": "email"
}
]
}
]
},
"profile": {
"provider": {
"affiliation": "None",
"license": {
"number": "777",
"state": "Alabama"
},
"npi": "798798798",
"specialty": "Allergy and Immunology",
"state": "processing",
"visibility": {
"provider": false,
"public": false
}
}
},
"roles": [
"000000000000000000000005"
],
"shared": false,
"state": "verified",
"updated": "2015-03-12T18:47:34.010Z"
}