ProfileField

A profile field defines a single field of a user's profile, such as 'Phone Number' or 'Job Title'. It does not contain any user data related to the field. A profile field can be a variety of types (textfield, select list, etc) and collectively create a user's profile.

Example:
Example JSON
{
  "id" : "5501",
  "profileHeader" : true,
  "texts" : [ {
       "displayName" : "Title",
       "description" : "Whatever appears on your business card will do nicely.",
       "language" : "en"
  } ],
  "visibilityDefault" : "registered",
  "visibilityEditable" : true,
  "name" : "Title",
  "type" : "profileField",
  "fieldType" : "text",
  "required" : false,
  "index" : 0,
  "editable" : true,
  "filterable" : true,
  "searchable" : true,
  "externallyManaged" : false,
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/admin/profileFields/5501",
      "allowed" : [ "PUT", "DELETE", "GET" ]
    }
  }
}
Since: 3.13

Fields

FieldTypeMode Description
editableBooleanrequired

Flag indicating that this profile field is editable by the user.

externallyManagedBooleanread-only

Flag indicating that this field is managed by some external system such as LDAP. When this is true, it is not possible to edit the field.

fieldTypeStringrequired

The type of this profile field. Valid values are:

  • boolean
  • date
  • decimal
  • email
  • number
  • largetext
  • multilist
  • singlelist
  • text
  • url
  • phone_number
  • zip_code
  • address
filterableBooleanrequired

Flag indicating that this field is filterable (has a defined set of options).

idStringread-only

Identifier of this object.

indexIntegerread-only

The index of this profile field. The index specifies the order in which the profile fields will be displayed.

nameStringrequired

The internal name of this profile field. The internal name is unique and generally used for internal actions.

optionsProfileFieldOption[]optional

Valid options when the field is of type multilist or singlelist. This field is required when field type is multilist or singlelist.

profileHeaderBooleanread-only

Flag indicating that this field is part of the header profile.

requiredBooleanrequired

Flag indicating that this field MUST be included on a create or update request.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

searchableBooleanrequired

Flag indicating that this field is going to be indexed thus making it searchable.

textsProfileFieldText[]required

List of ProfileFieldText that describe the display name and description of this field in different languages. At least one language should be defined.

typeStringread-only

The object type of this object ("profileField").

visibilityDefaultStringrequired

Default visibility for this field. Users may or may not be allowed to override this default value.

  • registered - Everyone can see this field
  • colleagues - Only available in Jive internal
  • connections - User's connections / friends can see this field
  • connections_and_colleagues - Only available in Jive internal
  • private - Private to the user
  • all_but_partner - Everyone except external contributors. Only available in Jive internal
visibilityEditableBooleanrequired

Flag indicating that users may or may not be able to override the default visibility value.

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

Resources

ResourceMethodDescription
selfGET

Return an updated version of this profile field.

Retrieves:
  • ProfileField
  • selfPUT

    Update the information for this profile field, and return an updated representation of it.

    Retrieves:
  • ProfileField
  • selfDELETE

    Remove this profile field.