osapi.jive.corev3.Jive
Contains Jive extensions to the OpenSocial person object. This entity
is included as the field jive in a Person. An example JSON representation looks like this:
{ "level" : { "name" : "Scout", "points" : 582 }, "username" : "admin", "external" : false, "visible" : true, "enabled" : true, "externalContributor" : false, "federated" : false }
Properties
| Property | Type | Mode † | Description |
|---|---|---|---|
enabled | Boolean | optional | ↑ Flag indicating whether this person is allowed to log in. Default is true. |
external | Boolean | optional | ↑ Flag indicating whether this person is simply a representation of an external identity, not an actual person. Default is false. |
externalContributor | Boolean | optional | ↑ Flag indicating that this person is an external contributor. Default is false. Availability:Can only be set to true if the external contributors feature has been enabled on this Jive instance. |
federated | Boolean | optional | ↑ Flag indicating that this person is federated (identify is managed outside the Jive application). Default is false. |
lastProfileUpdate | ISO 8601 Date | read-only | ↑ Date and time of the last change to any profile field ( Since: 3.5 |
level | Level | read-only | ↑ The current status level for this person based on his points. For instance, "Newbie", "Adventurer", etc. |
locale | String | optional | ↑ Locale identifier for this person. Will typically be either language (en) or language_country (en_US). Consult the Locale Metadata service for locales supported by this Jive instance. Availability:Only present when this Jive instance allows users to manage their own locale settings Since: 3.1 |
password | String | required | ↑ The login password for this person. This field is never actually returned; instead it is present to allow a password to be set or updated when a person is created or updated, respectively. Password is required for person creation. |
profile | Profile | read-only | ↑ The Jive profile fields for this person. All profile fields that are not an address, an email, a phone or a location are going to be listed by this entity. |
termsAndConditionsRequired | Boolean | read-only | ↑ |
timeZone | String | optional | ↑ Time zone identifier for this person. Will be a standard time zone identifier like "America/Los_Angeles".
Consult the Time Zone Metadata service for time zones supported by this Jive instance, including a
Availability:Only present when this Jive instance allows users to manage their own time zone settings Since: 3.1 |
username | String | required | ↑ The login username for this person. This field is required for person creation, but cannot be changed on an update. |
viewContent | Boolean | read-only | ↑ Flag indicating that this person is allowed to see the requested content. ,Since: 3.5 |
visible | Boolean | read-only | ↑ Flag indicating that this person is a regular user, visible to the rest of the system, as opposed to an internal system account. |