Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - userProfileData

  • Article
  • 4 minutes to read

Description

No description provided

Properties

Name Type Occurrence Description
userId accountIdType Optional User Id. If not specified, then logged-in user’s Id will be assumed.
user accountBasicDetailsType Optional The basic info of the user.(Not applicable for update)
employeeId accountIdType Optional The employee id of the user (Not applicable for update)
firstName nameType Optional
Nillable		 The first name of the user
middleName nameType Optional
Nillable		 The middle name of the user
lastName nameType Optional
Nillable		 The last name of the user
handle nameType Optional
Nillable		 The display handle of the user
jobTitle xs:string Optional
Nillable		 The job title of the user
jobDescription xs:string Optional
Nillable		 The job description
homeOrganization groupIdType Optional
Nillable		 The home organization of the user. (Not applicable for update)
siteId xs:integer Optional The site identifier where user is based
siteName xs:string Optional
Nillable		 The site name where user is based. (Not applicable for update)
group Array<accountGroupListType> Optional The groups to which user belong. (Not applicable for update)
manager xs:string Optional
Nillable		 The manager of the user
managerName xs:string Optional
Nillable		 The display name of the user’s manager (Not applicable for update)
workPhone xs:string Optional
Nillable		 The work phone number of the user
workMobile xs:string Optional
Nillable		 The work mobile phone number of the user
email xs:string Optional The work email id of the user
qualifications xs:string Optional
Nillable		 The qualifications and the trainings of the user
interests xs:string Optional
Nillable		 The work related interests of the user
expertise xs:string Optional
Nillable		 The work skills and expertise of the user
gender xs:string Optional
Nillable		 The gender of the user
dob xs:dateTime Optional
Nillable		 The date of the birth of the user
nationality xs:string Optional
Nillable		 The nationality of the user
religion xs:string Optional
Nillable		 The religion of the user
homeTelephone xs:string Optional The home telephone number of the user
socialNetworkA xs:anyURI Optional Social network identifier of the user.(e.g twitter)
socialNetworkB xs:anyURI Optional Social network identifier of the user.
socialNetworkC xs:anyURI Optional Social network identifier of the user.(e.g. Facebook)
socialNetworkD xs:anyURI Optional Social network identifier of the user.(e.g. Professional blog)
socialNetworkE xs:anyURI Optional Social network identifier of the user.
socialNetworkF xs:anyURI Optional Social network identifier of the user.
socialNetworkG xs:anyURI Optional Social network identifier of the user.
socialNetworkH xs:anyURI Optional Social network identifier of the user.
personalInterests xs:string Optional The personal interests of the user.
homeAddress xs:string Optional
Nillable		 The home address of the user.
personalBlog xs:anyURI Optional
Nillable		 The personal blog of the user.
department xs:string Optional
Nillable		 The department of the user
userType accountUserType Optional The type of the user account. (Not applicable for update)
attrib1 xs:string Optional
Nillable		 The custom attrib1 for the user
attrib2 xs:string Optional
Nillable		 The custom attrib2 for the user
attrib3 xs:string Optional
Nillable		 The custom attrib3 for the user
attrib4 xs:string Optional
Nillable		 The custom attrib4 for the user
attrib5 xs:string Optional
Nillable		 The custom attrib5 for the user
attrib6 xs:string Optional
Nillable		 The custom attrib6 for the user
attrib7 xs:string Optional
Nillable		 The custom attrib7 for the user
attrib8 xs:string Optional
Nillable		 The custom attrib8 for the user
language xs:language Optional Specify the language for the user. Language code as defined in RFC 3066 and ISO 639-1. Some example values for this datatype are: “en-GB”, “fr-FR”. Use utility::spellGetLanguageList operation to get all available languages.
timezone xs:string Optional The default Time Zone applied to this user. If you want to get a list of timezones, please see the time::getTimezoneList operation.
country xs:string Optional The country that the user is based in.
dateTimeFormat xs:string Optional The default date/time format of the user.
dateFormat xs:string Optional The default date format of the user.
timeFormat xs:string Optional The default time format of the user.
lastLogon xs:dateTime Optional The last logon time of the user. (Not applicable for update)
securityOptions userAccountSecurityOptionsType Optional Security options.
twofaMethod twofaMethodType Optional the currently selected two-factor authentication method.
twofaTotpRegistered xs:boolean Optional Set to true if a TOTP authenticator is already registered.
twofaMandatoryEffective xs:boolean Optional Set to true if two-factor authentication is mandatory for this account and so cannot be turned off or changed by the account holder. This is the effective answer, it is true when the account carries the twofaMandatory security option and also when two-factor authentication has been made mandatory for all accounts by the instance policy. Read only, it is ignored on userProfileSet. Use this rather than securityOptions/twofaMandatory, which reports only the option held on the account.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document