Linchpin User Profiles - Documentation
Create a meaningful and up to date profile
See the documentation for your Release
REST APIs
The Custom User Profile has a RESTful API to retrieve useful information for any kind of external usage. All endpoints return their data as JSON strings (a standardized lightweight data-interchange format).
Do you miss some features here? Please feel free to let us know.
Profile Fields API
The Profile Fields API gives you all informations about the configured fields. The Profile Fields API is available under YOUR_DOMAIN_AND_CONTEXT/rest/cup/1.0/fields.
Retrieve a list of all configured user profile fields.
URL: /rest/cup/1.0/fields
Method: GET
Results in a complete list of configured fields:
[
{
"userFieldPK":5,
"userFieldBK":"cup.fachbereich-5",
"labelPropertyKey":"Abteilung",
"ldapKey":"ou",
"position":0,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":16,
"userFieldBK":"cup.titel-16",
"labelPropertyKey":"Titel",
"ldapKey":"title",
"position":0,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":8,
"userFieldBK":"cup.vorname-8",
"labelPropertyKey":"Name",
"ldapKey":"cn",
"position":1,
"hidden":false,
"inVCard":true
},
{
"userFieldPK":13,
"userFieldBK":"cup.abteilungsnummer-13",
"labelPropertyKey":"Abteilungsnummer",
"ldapKey":"departmentNumber",
"position":1,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":6,
"userFieldBK":"cup.ort-6",
"labelPropertyKey":"Ort",
"ldapKey":"l",
"position":2,
"hidden":false,
"inVCard":true
},
{
"userFieldPK":11,
"userFieldBK":"cup.telefon-11",
"labelPropertyKey":"Telefon",
"ldapKey":"telephoneNumber",
"position":2,
"hidden":false,
"inVCard":true
},
{
"userFieldPK":7,
"userFieldBK":"cup.land-7",
"labelPropertyKey":"Land",
"ldapKey":"st",
"position":3,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":10,
"userFieldBK":"cup.e-mail-10",
"labelPropertyKey":"E-Mail",
"ldapKey":"mail",
"position":3,
"hidden":false,
"inVCard":true
},
{
"userFieldPK":12,
"userFieldBK":"cup.fachbereich-12",
"labelPropertyKey":"Fachbereich",
"ldapKey":"businessCategory",
"position":4,
"hidden":false,
"inVCard":true
},
{
"userFieldPK":15,
"userFieldBK":"cup.sprache-15",
"labelPropertyKey":"Sprache",
"ldapKey":"preferredLanguage",
"position":4,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":14,
"userFieldBK":"cup.raumnummer-14",
"labelPropertyKey":"Raumnummer",
"ldapKey":"roomNumber",
"position":5,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":17,
"userFieldBK":"cup.stufe-17",
"labelPropertyKey":"Stufe",
"ldapKey":"employeeType",
"position":6,
"hidden":false,
"inVCard":false
},
{
"userFieldPK":18,
"userFieldBK":"cup.jourfix-18",
"labelPropertyKey":"Jour Fix",
"ldapKey":"",
"position":10,
"hidden":true,
"inVCard":false
},
{
"userFieldPK":19,
"userFieldBK":"cup.vorgesetzter-19",
"labelPropertyKey":"Vorgesetzter",
"ldapKey":"",
"position":120,
"hidden":false,
"inVCard":false
}
]
Get a list of all values (sorted and unique) used for one field
With this endpoint of the Profile Fields API you can get all set values for one specific field.
URL: /rest/cup/1.0/fields/{fieldKey}Parameters:
fieldKey: field key ("userFieldBK") configured in CUP
Method: GET
Results in a list of all given user values:
["Catering","Consulting","Executive","Legals","Sales","Services","Systems","Technologies"]
User Profile API
The User Profile API provides various profile information. The API is available under DOMAIN_AND_CONTEXT/rest/cup/1.0/profile.
Get the CUP profile of the current user
With this endpoint of the User Profile API you can get the complete profile data of the currently logged in user.
URL: DOMAIN_AND_CONTEXT/rest/cup/1.0/profile
Method: GET
Results in a complete set of profile information:
{
"cup.abteilungsnummer-13":"712",
"cup.e-mail-10":"Buckminster.Powell@Sales.company.com",
"cup.fachbereich-12":"Accounting",
"cup.fachbereich-5":"Sales",
"cup.jourfix-18":null,
"cup.land-7":"Germany",
"cup.ort-6":"Kassel",
"cup.raumnummer-14":"5925",
"cup.sprache-15":"DE",
"cup.stufe-17":"Staff",
"cup.telefon-11":"(003) 28547554",
"cup.titel-16":"0",
"cup.vorgesetzter-19":null,
"cup.vorname-8":"Buckminster Powell"
}
Get the CUP profile of a given user
With this endpoint of the User Profile API you can get the complete profile data of any given user.
URL: DOMAIN_AND_CONTEXT/rest/cup/1.0/profile/{userName}Parameters:
userName: confluence user name for the profile you want to retrieve
Method: GET
Results in a complete set of profile information of a specified user:
{
"cup.abteilungsnummer-13":"580",
"cup.e-mail-10":"Bianca.Villarreal@Executive.company.com",
"cup.fachbereich-12":"Advertising",
"cup.fachbereich-5":"Executive",
"cup.jourfix-18":null,
"cup.land-7":"Norway",
"cup.ort-6":"Oslo",
"cup.raumnummer-14":"2843",
"cup.sprache-15":"EN",
"cup.stufe-17":"Executive",
"cup.telefon-11":"(08122) 5570356",
"cup.titel-16":"0",
"cup.vorgesetzter-19":null,
"cup.vorname-8":"Bianca Villarreal"
}