Page tree
Skip to end of metadata
Go to start of metadata

REST APIs

The Linchpin User Profiles 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.

Please be aware, that all APIs might be subject to change without prior announcement!


{ "swagger": "2.0", "info": { "version": "2.17.3", "title": "Linchpin User Profiles" }, "host": "", "basePath": "/rest/cup/1.0/profile/", "schemes": [ "http" ], "paths": { "/assistant/config": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ProfileDataAssistantEntry" } } } } }, "put": { "consumes": [ ], "produces": [ ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/ProfileDataAssistantEntry" } } } ], "responses": { "204": { "description": "No Content", "headers": { } } } } }, "/cascadeimport/{userFieldBK}/import": { "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "dataSourceURL", "in": "path", "required": true }, { "type": "string", "name": "userFieldBK", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { } }, "403": { "description": "Forbidden", "headers": { } } } } }, "/cascadeimport/{userFieldBK}/importstatus": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "userFieldBK", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ImportProgressDto" } }, "403": { "description": "Forbidden", "headers": { } } } } }, "/categories/{username}": { "get": { "description": "Get a list of all profile field categories (including the corresponding fields with translated property names).", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "username", "in": "path", "required": true, "description": "Username of the user, to get the visible categories for" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/FieldCategoryDto" } } }, "404": { "description": "Not Found", "headers": { } } } } }, "/contacts": { "get": { "description": "Returns all contacts specified by a contactType, optionally filtered by user groups", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "contactType", "in": "query", "required": true }, { "type": "array", "items": { "type": "string" }, "name": "groups", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserContactListDto" } } }, "deprecated": true } }, "/contacts/groups": { "get": { "description": "Returns all contacts specified by a contactType, optionally filtered by user groups and grouped together by the tags the user put to the contacts", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "contactType", "in": "query", "required": true }, { "type": "array", "items": { "type": "string" }, "name": "groups", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ContactGroupsResult" } } } } }, "/contacts/groups/{userName}": { "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "userName", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "name": "contactGroups", "in": "formData", "required": true }, { "type": "string", "name": "contactNote", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ContactGroupsResult" } }, "404": { "description": "Not Found", "headers": { } } } } }, "/contacts/{contactId}": { "delete": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "integer", "name": "contactId", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "headers": { } } } } }, "/contacts/{contactType}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "contactType", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "name": "user", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } } } }, "post": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "contactType", "in": "path", "required": true }, { "type": "string", "name": "userName", "in": "formData", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserContactDto" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } }, "409": { "description": "Conflict", "headers": { }, "schema": { "type": "string" } } } } }, "/contacts/{contactType}/{userName}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "contactType", "in": "path", "required": true }, { "type": "string", "name": "userName", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/IsContactResult" } }, "404": { "description": "Not Found", "headers": { }, "schema": { "type": "string" } } } } }, "/editors": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ProfileEditPermissionDto" } } }, "404": { "description": "Not Found", "headers": { } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProfileEditPermissionDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ProfileEditPermissionDto" } } } } }, "/editors/{type}/{id}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "id", "in": "path", "required": true }, { "type": "string", "enum": [ "group", "user" ], "name": "type", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ProfileEditPermissionDto" } }, "400": { "description": "Bad Request", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "id", "in": "path", "required": true }, { "type": "string", "enum": [ "group", "user" ], "name": "type", "in": "path", "required": true } ], "responses": { "202": { "description": "Accepted", "headers": { } }, "400": { "description": "Bad Request", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/fancytree/nodes/{userFieldBK}": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "userFieldBK", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/FancyTreeNodeDto" } } } } } }, "/fancytree/nodes/{userFieldBK}/{parentPath }": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "parentPath", "in": "path", "required": true }, { "type": "string", "name": "userFieldBK", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { "Cache-Control": { "type": "string" } }, "schema": { "$ref": "#/definitions/ResponseWrapper" } } } } }, "/fields": { "get": { "description": "Get a list of all profile fields.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "name": "addConfluenceDefaultUserFields", "in": "query", "required": true }, { "type": "boolean", "name": "profileOnly", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/UserFieldDto" } } } } } }, "/fields/countries": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/CountryOrLanguageOptionDto" } } } } } }, "/fields/imStatusEnabled": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ImmutableMap" } }, "401": { "description": "Unauthorized", "headers": { } } } } }, "/fields/languages": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/CountryOrLanguageOptionDto" } } } } } }, "/fields/{fieldKey}": { "get": { "description": "Get a list of all values (sorted and unique) used for a profile field.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "fieldKey", "in": "path", "required": true, "description": "Profile field key you want to get." } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } } } } }, "/layout": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ProfileLayoutOutputDto" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProfileLayoutInputDto" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ProfileLayoutOutputDto" } }, "403": { "description": "Forbidden", "headers": { } } } } }, "/loginwizard": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/Object_2" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "400": { "description": "Bad Request", "headers": { } } } } }, "/migration": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/ConfluenceProfileMigrationRestAPI$1" } }, "403": { "description": "Forbidden", "headers": { } } } }, "post": { "consumes": [ ], "produces": [ ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { } }, "403": { "description": "Forbidden", "headers": { } } } } }, "/onboarding/config": { "get": { "consumes": [ ], "produces": [ ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "string" } } } }, "put": { "consumes": [ ], "produces": [ ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { } } } } }, "/onboarding/picture/allowed": { "get": { "description": "upload is not allowed when picture is retrieved from LDAP or URL", "consumes": [ ], "produces": [ ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "boolean" } } } } }, "/onboarding/picture/upload": { "post": { "consumes": [ "application/json" ], "produces": [ ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProfilePictureOnboardingRestService$ImageUpload" } } ], "responses": { "200": { "description": "OK", "headers": { } }, "400": { "description": "Bad Request", "headers": { }, "schema": { "type": "string" } }, "403": { "description": "Forbidden", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/order": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/CategoryOrderDto" } } } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "array", "items": { "$ref": "#/definitions/Object" } } }, "400": { "description": "Bad Request", "headers": { } }, "403": { "description": "Forbidden", "headers": { } } } } }, "/profile": { "get": { "description": "Retrieves the profile data for the current user.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "401": { "description": "Unauthorized", "headers": { } } } } }, "/profile/cascadecontent": { "post": { "description": "Get the rendered version for a list of cascade field paths.", "consumes": [ ], "produces": [ ], "parameters": [ { "type": "string", "name": "dataPaths", "in": "formData", "required": true, "description": "String representation of a list that contains the cascade values paths" }, { "type": "string", "name": "userFieldBK", "in": "formData", "required": true, "description": "Key of the cascade field." } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "string" } } } } }, "/profile/{userName}": { "get": { "description": "Returns the profile of a single user.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "userName", "in": "path", "required": true, "description": "Username of the user to get the profile for." }, { "type": "boolean", "name": "rendered", "in": "query", "required": false, "default": "false" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "object" } }, "401": { "description": "Unauthorized", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/profile/{userName}/category/contact": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "userName", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "headers": { } }, "404": { "description": "Not Found", "headers": { } } } } }, "/search/users/by/cql": { "get": { "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "string", "name": "cql", "in": "query", "required": true }, { "type": "string", "name": "order", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchResultDto" } } } } }, "/search/users/by/fieldsandvalues": { "get": { "description": "Gib mir alle Profile, die die übergebenen Profilfeld-Wert-Kombination beinhalten (z.b. confluence.im=skype, cup.team=mahou).\nOptional: Filtere das Ergebnis nach Mitgliedern in den übergebenen Gruppen-Parametern", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "name": "extendedSearch", "in": "query", "required": false, "default": "true" }, { "type": "array", "items": { "type": "string" }, "name": "group", "in": "query", "required": true }, { "type": "integer", "name": "limit", "in": "query", "required": false, "default": "1000" }, { "type": "integer", "name": "offset", "in": "query", "required": false, "default": "0" }, { "type": "string", "name": "order", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchResultDto" } } } } }, "/search/users/by/userSearchMacro": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserSearchMacroSearchRequest" }, "description": "from UserSearchMacro" } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchResultDto" } } } } }, "/search/users/by/valuesInAnyField": { "get": { "description": "Gibt alle Profile zurück, die den Wert des Parameter 'values' in den unter 'fieldnames' angegebenen Profilfeldern beinhalten.\nIst der Parameter 'fieldnames' leer, so werden alle Profilfelder durchsucht.\nOptional: Filtere das Ergebnis nach Mitgliedern in den mit 'groupnames' übergebenen Benutzergruppen. Ist dieser Parameter leer, so wird in allen\nBenutzergruppen gesucht.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ { "type": "boolean", "name": "extendedSearch", "in": "query", "required": false, "default": "false" }, { "type": "array", "items": { "type": "string" }, "name": "field", "in": "query", "required": true }, { "type": "array", "items": { "type": "string" }, "name": "group", "in": "query", "required": true }, { "type": "integer", "name": "limit", "in": "query", "required": false, "default": "1000" }, { "type": "integer", "name": "offset", "in": "query", "required": false, "default": "0" }, { "type": "array", "items": { "type": "string" }, "name": "value", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "$ref": "#/definitions/UserSearchResultDto" } } } } }, "/search/users/countries": { "get": { "description": "Gibt mir alle Länder aus dem Country-Service in der Locale des aktuellen Benutzers zurück.", "consumes": [ ], "produces": [ "application/json" ], "parameters": [ ], "responses": { "200": { "description": "OK", "headers": { }, "schema": { "type": "string" } } } } } }, "definitions": { "CategoryOrderDto": { "properties": { "categoryPk": { "type": "integer" }, "fieldPks": { "type": "array", "items": { "type": "integer" } }, "subtitle": { "type": "integer" } } }, "ConfluenceProfileMigrationRestAPI$1": { "properties": { } }, "ContactGroupDto": { "properties": { "contactDtos": { "type": "array", "items": { "$ref": "#/definitions/UserContactDto" } }, "name": { "type": "string" } } }, "ContactGroupsResult": { "properties": { "contactGroups": { "type": "array", "items": { "$ref": "#/definitions/ContactGroupDto" } } } }, "CountryOrLanguageOptionDto": { "properties": { "labelKey": { "type": "string" }, "localizedLabelKey": { "type": "string" } } }, "FancyTreeNodeDto": { "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/FancyTreeNodeDto" } }, "id": { "type": "integer" }, "key": { "type": "string" }, "keyPath": { "type": "string" }, "lazy": { "type": "boolean" }, "parentId": { "type": "integer" }, "title": { "type": "string" } } }, "FieldCategoryDto": { "properties": { "categoryPk": { "type": "integer" }, "contactArea": { "type": "boolean" }, "labelPropertyKey": { "type": "string" }, "layoutContainer": { "type": "string" }, "localizedLabel": { "type": "string" }, "position": { "type": "integer" }, "restrictionGroups": { "type": "array", "items": { "type": "string" } }, "userFields": { "type": "array", "items": { "$ref": "#/definitions/UserFieldDto" } } } }, "ImmutableMap": { "properties": { "empty": { "type": "boolean" } } }, "ImportProgressDto": { "properties": { "hasErrors": { "type": "boolean" }, "importedDataCounter": { "type": "integer" }, "isRunning": { "type": "boolean" }, "percentage": { "type": "integer" }, "remainingTime": { "type": "string" }, "running": { "type": "boolean" }, "totalData": { "type": "integer" } } }, "InstantMessagingOptionsDto": { "properties": { "discoveryHost": { "type": "string" }, "host": { "type": "string" }, "label": { "type": "string" }, "localizedLabel": { "type": "string" }, "statusEnabled": { "type": "boolean" }, "type": { "type": "string", "enum": [ "JABBER", "SKYPE" ] } } }, "IsContactResult": { "properties": { "contactId": { "type": "integer" } } }, "LinkOptionsDto": { "properties": { "label": { "type": "string" }, "linkEnabled": { "type": "boolean" }, "localizedLabel": { "type": "string" }, "url": { "type": "string" } } }, "Object": { "properties": { } }, "Object_2": { "properties": { } }, "ProfileDataAssistantEntry": { "properties": { "uuid": { "type": "string" }, "value": { "$ref": "#/definitions/ProfileDataAssistantEntryValue" } } }, "ProfileDataAssistantEntryValue": { "properties": { "leftFieldConfig": { "type": "array", "items": { "type": "string" } }, "remindAlways": { "type": "boolean" }, "rightFieldConfig": { "type": "array", "items": { "type": "string" } } } }, "ProfileEditPermissionDto": { "properties": { "editableUserOrGroup": { "$ref": "#/definitions/ProfileEditPermissionDto$UserOrGroup" }, "editorGroups": { "type": "array", "items": { "$ref": "#/definitions/ProfileEditPermissionDto$UserOrGroup" } }, "editorUsers": { "type": "array", "items": { "$ref": "#/definitions/ProfileEditPermissionDto$UserOrGroup" } } } }, "ProfileEditPermissionDto$UserOrGroup": { "properties": { "id": { "type": "string" }, "picture": { "type": "string" }, "text": { "type": "string" }, "type": { "type": "string", "enum": [ "group", "user" ] } } }, "ProfileLayoutContainerDto": { "properties": { "categories": { "type": "array", "items": { "$ref": "#/definitions/FieldCategoryDto" } }, "ident": { "type": "string" } } }, "ProfileLayoutInputCategoryDto": { "properties": { "category": { "type": "integer" }, "position": { "type": "integer" } } }, "ProfileLayoutInputContainerDto": { "properties": { "categories": { "type": "array", "items": { "$ref": "#/definitions/ProfileLayoutInputCategoryDto" } }, "ident": { "type": "string" } } }, "ProfileLayoutInputDto": { "properties": { "container": { "type": "array", "items": { "$ref": "#/definitions/ProfileLayoutInputContainerDto" } } } }, "ProfileLayoutOutputDto": { "properties": { "containerDtos": { "type": "array", "items": { "$ref": "#/definitions/ProfileLayoutContainerDto" } } } }, "ProfilePictureOnboardingRestService$ImageUpload": { "properties": { "base64": { "type": "string" } } }, "ReferenceMappingDto": { "properties": { "dependentFieldBk": { "type": "string" }, "pK": { "type": "integer" }, "sourceFilter": { "type": "string" }, "targetValue": { "type": "string" } } }, "ResponseWrapper": { "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/Object" } } } }, "UserContactDto": { "properties": { "contactNote": { "type": "string" }, "contactType": { "type": "string" }, "contactUserProfile": { "type": "object" }, "email": { "type": "string" }, "fullName": { "type": "string" }, "groups": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "imStatusFieldValue": { "type": "string" }, "profilePictureUrl": { "type": "string" }, "subtitleFieldValue": { "type": "string" }, "userName": { "type": "string" } } }, "UserContactListDto": { "properties": { "contacts": { "type": "array", "items": { "$ref": "#/definitions/UserContactDto" } } } }, "UserFieldDto": { "properties": { "confluenceCUPField": { "type": "boolean" }, "dataSourceUrl": { "type": "string" }, "fieldCategoryPK": { "type": "integer" }, "fieldType": { "type": "string", "enum": [ "CASCADE", "COUNTRY", "DATE", "DEPENDENT", "IM", "INPUT", "LANGUAGE", "LDAP", "MULTISELECT", "PHONE", "SELECT", "TEXTAREA", "USER", "XML" ] }, "helpTextKey": { "type": "string" }, "hidden": { "type": "boolean" }, "inVCard": { "type": "boolean" }, "instantMessagingOptionsDto": { "$ref": "#/definitions/InstantMessagingOptionsDto" }, "labelPropertyKey": { "type": "string" }, "ldapField": { "type": "boolean" }, "ldapKey": { "type": "string" }, "linkField": { "type": "boolean" }, "linkOptionsDto": { "$ref": "#/definitions/LinkOptionsDto" }, "localizedFieldCategoryLabel": { "type": "string" }, "localizedHelpText": { "type": "string" }, "localizedLabel": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/definitions/UserFieldOptionDto" } }, "originFieldKey": { "type": "string" }, "position": { "type": "integer" }, "referenceFieldBK": { "type": "string" }, "referenceMappings": { "type": "array", "items": { "$ref": "#/definitions/ReferenceMappingDto" } }, "renderStrategy": { "$ref": "#/definitions/UserPropertyRenderStrategy" }, "required": { "type": "boolean" }, "subtitle": { "type": "boolean" }, "type": { "type": "string", "enum": [ "CASCADE", "COUNTRY", "DATE", "DEPENDENT", "IM", "INPUT", "LANGUAGE", "LDAP", "MULTISELECT", "PHONE", "SELECT", "TEXTAREA", "USER", "XML" ] }, "userFieldBK": { "type": "string" }, "userFieldPK": { "type": "integer" }, "writeToLdapEnabled": { "type": "boolean" }, "xmlField": { "type": "boolean" }, "xmlKey": { "type": "string" } } }, "UserFieldOptionDto": { "properties": { "fieldOptionPK": { "type": "integer" }, "labelKey": { "type": "string" }, "localizedLabelKey": { "type": "string" }, "optionPosition": { "type": "integer" } } }, "UserPropertyRenderStrategy": { "properties": { } }, "UserSearchMacroSearchRequest": { "properties": { "fieldBks": { "type": "array", "items": { "type": "string" } }, "groupNames": { "type": "array", "items": { "type": "string" } }, "query": { "type": "string" } } }, "UserSearchResultDto": { "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/Object" } }, "timing": { "type": "integer" }, "total": { "type": "integer" } } } } }