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
Field | Type | Mode † | Description |
---|---|---|---|
fieldType | String | read-only | |
name | String | read-only | |
resources | Object | read-only | Resource links (and related permissions for the requesting person) relevant to this object. |
searchable | Boolean | read-only | |
type | String | read-only | |
visibilityDefault | String | required | Default visibility for this field. Users may or may not be allowed to override this default value.
|
visibilityEditable | Boolean | required | Flag indicating that users may or may not be able to override the default visibility value. |
Resources
Resource | Method | Description |
---|---|---|
self | GET | Return an updated version of this profile field. Retrieves: |
self | PUT | Update the information for this profile field, and return an updated representation of it. Retrieves: |
self | DELETE | Remove this profile field. |