Skip to content

Latest commit

 

History

History
52 lines (49 loc) · 95.1 KB

File metadata and controls

52 lines (49 loc) · 95.1 KB

PersonMetadata

Fields

Field Type Required Description Example
type Optional<PersonMetadataType> N/A FULL_TIME
firstName Optional<String> The first name of the person
lastName Optional<String> The last name of the person
title Optional<String> Job title.
businessUnit Optional<String> Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
department Optional<String> An organizational unit where everyone has a similar task, e.g. Engineering.
teams List<PersonTeam> Info about the employee's team(s).
departmentCount Optional<Long> The number of people in this person's department.
email Optional<String> The user's primary email address
aliasEmails List<String> Additional email addresses of this user beyond the primary, if any.
location Optional<String> User facing string representing the person's location.
structuredLocation Optional<StructuredLocation> Detailed location with information about country, state, city etc.
externalProfileLink Optional<String> Link to a customer's internal profile page. This is set to '#' when no link is desired.
manager Optional<Person> N/A {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
managementChain List<Person> The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
phone Optional<String> Phone number as a number string.
timezone Optional<String> The timezone of the person. E.g. "Pacific Daylight Time".
timezoneOffset Optional<Long> The offset of the person's timezone in seconds from UTC.
timezoneIANA Optional<String> The IANA timezone identifier, e.g. "America/Los_Angeles".
photoUrl Optional<String> The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
uneditedPhotoUrl Optional<String> The original photo URL of the person's avatar before any edits they made are applied
bannerUrl Optional<String> The URL of the person's banner photo.
reports List<Person> N/A
startDate LocalDate The date when the employee started.
endDate LocalDate If a former employee, the last date of employment.
bio Optional<String> Short biography or mission statement of the employee.
pronoun Optional<String> She/her, He/his or other pronoun.
orgSizeCount Optional<Long> The total recursive size of the people reporting to this person, or 1
directReportsCount Optional<Long> The total number of people who directly report to this person, or 0
preferredName Optional<String> The preferred name of the person, or a nickname.
socialNetwork List<SocialNetwork> List of social network profiles.
datasourceProfile List<DatasourceProfile> List of profiles this user has in different datasources / tools that they use.
querySuggestions Optional<QuerySuggestionList> N/A
peopleDistance List<PersonDistance> List of people and distances to those people from this person. Optionally with metadata.
inviteInfo Optional<InviteInfo> Information regarding the invite status of a person.
isSignedUp Optional<Boolean> Whether the user has signed into Glean at least once.
lastExtensionUse OffsetDateTime The last time the user has used the Glean extension in ISO 8601 format.
permissions Optional<Permissions> Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles.
When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
customFields List<CustomFieldData> User customizable fields for additional people information.
loggingId Optional<String> The logging id of the person used in scrubbed logs, tracking GA metrics.
startDatePercentile Optional<Float> Percentage of the company that started strictly after this person. Between [0,100).
busyEvents List<AnonymousEvent> Intervals of busy time for this person, along with the type of event they're busy with.
profileBoolSettings Map<String, boolean> flag settings to indicate user profile settings for certain items
badges List<Badge> The badges that a user has earned over their lifetime.
isOrgRoot Optional<Boolean> Whether this person is a "root" node in their organization's hierarchy.