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
}

Fields

FieldTypeMode Description
enabledBooleanoptional

Flag indicating whether this person is allowed to log in. Default is true.

externalBooleanoptional

Flag indicating whether this person is simply a representation of an external identity, not an actual person. Default is false.

externalContributorBooleanoptional

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.

externalIdentitiesExternalIdentity[]optional

List of identities in external systems for this Person. Only users that can manage users in the application are allowed to see this information and update it.

Since: 3.6
federatedBooleanoptional

Flag indicating that this person is federated (identify is managed outside the Jive application). Default is false.

lastAuthenticatedISO 8601 Dateread-only

Date and time of the last time the person logged into the system.

Since: 3.8
lastProfileUpdateISO 8601 Dateread-only

Date and time of the last change to any profile field (addresses, emails, jive.profile, phoneNumbers) as well as jive.enabled, jive.external, jive.federated, jive.locale, jive.timeZone, jive.visible, and tags.

Since: 3.5
levelLevelread-only

The current status level for this person based on his points. For instance, "Newbie", "Adventurer", etc.

localeStringoptional

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
passwordStringrequired

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.

profileProfileread-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.

roleBadgeRoleBadgeread-only

The current role badge for this person

sendableBooleanread-only

Flag indicating whether the requesting person is allowed to send messages or shares to this person.

Since: 3.3
statusStringread-only

Published status of this person.

  • registered - Person registration has been completed successfully
  • awaiting_moderation - Person registration is waiting for moderation by an approver
  • rejected - Person registration has been rejected by an approver
  • awaiting_validation - Person registration request is awaiting validation
  • validated - Person registration request has been validated
  • invited - Person has been invited to join the community but has not yet registered
termsAndConditionsRequiredBooleanread-only

Flag indicating that this person has accepted the terms and conditions. This field is only visible to the authenticated user. A user or an admin is not allowed to see this field for other users so in those cases this field will not be present.

Since: 3.4
timeZoneStringoptional

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 displayName field that is localized based on the requesting user's configured locale.

Availability:

Only present when this Jive instance allows users to manage their own time zone settings

Since: 3.1
usernameStringrequired

The login username for this person. This field is required for person creation, but cannot be changed on an update.

viewContentBooleanread-only

Flag indicating that this person is allowed to see the requested content.

,
Since: 3.5
visibleBooleanread-only

Flag indicating that this person is a regular user, visible to the rest of the system, as opposed to an internal system account.

→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations