ProfileFieldName

A profile field like ProfileField that represents the name field of user profiles. Unlike a regular profile field, this entity contains less information. In particular, there is no global setting to know if name can be changed by end users since this decision is different per user. To get this information you will need to use GET /people/{personID}/profilePrivacy.

Example:
Example JSON
{
  "visibilityDefault" : "registered",
  "visibilityEditable" : true,
  "name" : "Name",
  "type" : "profileFieldName",
  "fieldType" : "text",
  "searchable" : true,
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/admin/profileFields/@name",
      "allowed" : [ "PUT", "GET" ]
    }
  }
}
Since: 3.14

Fields

FieldTypeMode Description
fieldTypeStringread-only
nameStringread-only
resourcesObjectread-only

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

searchableBooleanread-only
typeStringread-only
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.