Skip to content

Microsoft: Users user schemas (part 5)

11 Microsoft schemas with complete fields and constraints.

← Users user operations · All schemas

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, start Date Time broadcast Settings @odata type, allowed Audience, captions, is Attendee Report Enabled, is Question And Answer Enabled, is Recording Enabled, is Video On Demand Enabled

FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
allowedAudienceJSONOptionalDefines who can join the Teams live event. Possible values are listed in the following table.
allowedAudience (anyOf 1)stringAlternativeOne of: roleIsAttendee, organization, everyone, unknownFutureValue
allowedAudience (anyOf 2)JSONAlternative
allowedAudience (anyOf 2) (anyOf 1)objectAlternative
allowedAudience (anyOf 2) (anyOf 2)nullAlternative
captionsJSONOptionalCaption settings of a Teams live event.
captions (anyOf 1)ModelAlternativeExpand Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, recordings, start Date Time, transcripts broadcast Settings @odata type, allowed Audience, captions, is Attendee Report Enabled, is Question And Answer Enabled, is Recording Enabled, is Video On Demand Enabled captions @odata type, is Caption Enabled, spoken Language, translation Languages
captions (anyOf 2)JSONAlternative
captions (anyOf 2) (anyOf 1)objectAlternative
captions (anyOf 2) (anyOf 2)nullAlternative
isAttendeeReportEnabledJSONOptional
isAttendeeReportEnabled (anyOf 1)booleanAlternativeIndicates whether attendee report is enabled for this Teams live event. Default value is false.
isAttendeeReportEnabled (anyOf 2)nullAlternative
isQuestionAndAnswerEnabledJSONOptional
isQuestionAndAnswerEnabled (anyOf 1)booleanAlternativeIndicates whether Q&A is enabled for this Teams live event. Default value is false.
isQuestionAndAnswerEnabled (anyOf 2)nullAlternative
isRecordingEnabledJSONOptional
isRecordingEnabled (anyOf 1)booleanAlternativeIndicates whether recording is enabled for this Teams live event. Default value is false.
isRecordingEnabled (anyOf 2)nullAlternative
isVideoOnDemandEnabledJSONOptional
isVideoOnDemandEnabled (anyOf 1)booleanAlternativeIndicates whether video on demand is enabled for this Teams live event. Default value is false.
isVideoOnDemandEnabled (anyOf 2)nullAlternative

Referenced models: Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, recordings, start Date Time, transcripts broadcast Settings @odata type, allowed Audience, captions, is Attendee Report Enabled, is Question And Answer Enabled, is Recording Enabled, is Video On Demand Enabled captions @odata type, is Caption Enabled, spoken Language, translation Languages

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, start Date Time participants @odata type, attendees, organizer

FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
attendeesarrayOptionalInformation about the meeting attendees.
attendees[]ModelEach itemExpand Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, start Date Time participants @odata type, attendees, organizer attendees item
organizerJSONOptionalInformation about the meeting organizer.
organizer (anyOf 1)ModelAlternativeExpand Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, start Date Time participants @odata type, attendees, organizer attendees item
organizer (anyOf 2)JSONAlternative
organizer (anyOf 2) (anyOf 1)objectAlternative
organizer (anyOf 2) (anyOf 2)nullAlternative

Referenced models: Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, start Date Time participants @odata type, attendees, organizer attendees item

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type online Meetings item @odata type, attendee Report, broadcast Settings, creation Date Time, end Date Time, external Id, is Broadcast, meeting Template Id, participants, start Date Time participants @odata type, attendees, organizer attendees item

FieldTypePresenceDescription and constraints
$objectRootdiscriminator: {"mapping": {}, "propertyName": "@odata.type"}
@odata.typestringOptional
identityJSONOptionalIdentity information of the participant.
identity (anyOf 1)ModelAlternativeExpand Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type drives item @odata type, bundles, drive Type, following, items, list, owner, quota, root, share Point Ids, special, system owner @odata type, application, device, user
identity (anyOf 2)JSONAlternative
identity (anyOf 2) (anyOf 1)objectAlternative
identity (anyOf 2) (anyOf 2)nullAlternative
roleJSONOptionalSpecifies the participant's role in the meeting.
role (anyOf 1)stringAlternativeOne of: attendee, presenter, unknownFutureValue, producer, coorganizer
role (anyOf 2)JSONAlternative
role (anyOf 2) (anyOf 1)objectAlternative
role (anyOf 2) (anyOf 2)nullAlternative
upnJSONOptional
upn (anyOf 1)stringAlternativeUser principal name of the participant.
upn (anyOf 2)nullAlternative

Referenced models: Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type drives item @odata type, bundles, drive Type, following, items, list, owner, quota, root, share Point Ids, special, system owner @odata type, application, device, user

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).birthdayJSONOptional
$ (allOf 2).birthday (anyOf 1)stringAlternativeThe person's birthday.
$ (allOf 2).birthday (anyOf 2)nullAlternative
$ (allOf 2).companyNameJSONOptional
$ (allOf 2).companyName (anyOf 1)stringAlternativeThe name of the person's company.
$ (allOf 2).companyName (anyOf 2)nullAlternative
$ (allOf 2).departmentJSONOptional
$ (allOf 2).department (anyOf 1)stringAlternativeThe person's department.
$ (allOf 2).department (anyOf 2)nullAlternative
$ (allOf 2).displayNameJSONOptional
$ (allOf 2).displayName (anyOf 1)stringAlternativeThe person's display name.
$ (allOf 2).displayName (anyOf 2)nullAlternative
$ (allOf 2).givenNameJSONOptional
$ (allOf 2).givenName (anyOf 1)stringAlternativeThe person's given name.
$ (allOf 2).givenName (anyOf 2)nullAlternative
$ (allOf 2).imAddressJSONOptional
$ (allOf 2).imAddress (anyOf 1)stringAlternativeThe instant message voice over IP (VOIP) session initiation protocol (SIP) address for the user. Read-only.
$ (allOf 2).imAddress (anyOf 2)nullAlternative
$ (allOf 2).isFavoriteJSONOptional
$ (allOf 2).isFavorite (anyOf 1)booleanAlternativeTrue if the user has flagged this person as a favorite.
$ (allOf 2).isFavorite (anyOf 2)nullAlternative
$ (allOf 2).jobTitleJSONOptional
$ (allOf 2).jobTitle (anyOf 1)stringAlternativeThe person's job title.
$ (allOf 2).jobTitle (anyOf 2)nullAlternative
$ (allOf 2).officeLocationJSONOptional
$ (allOf 2).officeLocation (anyOf 1)stringAlternativeThe location of the person's office.
$ (allOf 2).officeLocation (anyOf 2)nullAlternative
$ (allOf 2).personNotesJSONOptional
$ (allOf 2).personNotes (anyOf 1)stringAlternativeFree-form notes that the user has taken about this person.
$ (allOf 2).personNotes (anyOf 2)nullAlternative
$ (allOf 2).personTypeJSONOptionalThe type of person.
$ (allOf 2).personType (anyOf 1)ModelAlternativeExpand Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company person Type @odata type, class, subclass
$ (allOf 2).personType (anyOf 2)JSONAlternative
$ (allOf 2).personType (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).personType (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).phonesarrayOptionalThe person's phone numbers.
$ (allOf 2).phones[]ModelEach itemExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number phones item
$ (allOf 2).postalAddressesarrayOptionalThe person's addresses.
$ (allOf 2).postalAddresses[]ModelEach itemExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item
$ (allOf 2).professionJSONOptional
$ (allOf 2).profession (anyOf 1)stringAlternativeThe person's profession.
$ (allOf 2).profession (anyOf 2)nullAlternative
$ (allOf 2).scoredEmailAddressesarrayOptionalThe person's email addresses.
$ (allOf 2).scoredEmailAddresses[]ModelEach itemExpand Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company scored Email Addresses item
$ (allOf 2).surnameJSONOptional
$ (allOf 2).surname (anyOf 1)stringAlternativeThe person's surname.
$ (allOf 2).surname (anyOf 2)nullAlternative
$ (allOf 2).userPrincipalNameJSONOptional
$ (allOf 2).userPrincipalName (anyOf 1)stringAlternativeThe user principal name (UPN) of the person. The UPN is an Internet-style login name for the person based on the Internet standard RFC 822. By convention, this should map to the person's email name. The general format is alias@domain.
$ (allOf 2).userPrincipalName (anyOf 2)nullAlternative
$ (allOf 2).websitesarrayOptionalThe person's websites.
$ (allOf 2).websites[]ModelEach itemExpand Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company websites item
$ (allOf 2).yomiCompanyJSONOptional
$ (allOf 2).yomiCompany (anyOf 1)stringAlternativeThe phonetic Japanese name of the person's company.
$ (allOf 2).yomiCompany (anyOf 2)nullAlternative

Referenced models: Get rule — response body — @odata type, id, Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company person Type @odata type, class, subclass, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number phones item, Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company scored Email Addresses item, Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company websites item

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company scored Email Addresses item

FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
addressJSONOptional
address (anyOf 1)stringAlternativeThe email address.
address (anyOf 2)nullAlternative
itemIdJSONOptional
itemId (anyOf 1)stringAlternative
itemId (anyOf 2)nullAlternative
relevanceScoreJSONOptionalThe relevance score of the email address. A relevance score is used as a sort key, in relation to the other returned results. A higher relevance score value corresponds to a more relevant result. Relevance is determined by the user’s communication and collaboration patterns and business relationships.
relevanceScore (oneOf 1)JSONAlternative
relevanceScore (oneOf 1) (anyOf 1)numberAlternativeFormat: double
relevanceScore (oneOf 1) (anyOf 2)nullAlternative
relevanceScore (oneOf 2)JSONAlternative
relevanceScore (oneOf 2) (anyOf 1)stringAlternative
relevanceScore (oneOf 2) (anyOf 2)nullAlternative
relevanceScore (oneOf 3)ModelAlternativeExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item coordinates @odata type, accuracy, altitude, altitude Accuracy, latitude, longitude accuracy value
selectionLikelihoodJSONOptional
selectionLikelihood (anyOf 1)stringAlternativeOne of: notSpecified, high
selectionLikelihood (anyOf 2)JSONAlternative
selectionLikelihood (anyOf 2) (anyOf 1)objectAlternative
selectionLikelihood (anyOf 2) (anyOf 2)nullAlternative

Referenced models: Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item coordinates @odata type, accuracy, altitude, altitude Accuracy, latitude, longitude accuracy value

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type people item @odata type, birthday, company Name, department, display Name, given Name, im Address, is Favorite, job Title, office Location, person Notes, person Type, phones, postal Addresses, profession, scored Email Addresses, surname, user Principal Name, websites, yomi Company websites item

FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
addressJSONOptional
address (anyOf 1)stringAlternativeThe URL of the website.
address (anyOf 2)nullAlternative
displayNameJSONOptional
displayName (anyOf 1)stringAlternativeThe display name of the web site.
displayName (anyOf 2)nullAlternative
typeJSONOptionalThe possible values are: other, home, work, blog, profile.
type (anyOf 1)stringAlternativeOne of: other, home, work, blog, profile
type (anyOf 2)JSONAlternative
type (anyOf 2) (anyOf 1)objectAlternative
type (anyOf 2) (anyOf 2)nullAlternative

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type photos item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).heightJSONOptional
$ (allOf 2).height (anyOf 1)numberAlternativeThe height of the photo. Read-only.
Format: int32
Maximum: 2147483647
Minimum: -2147483648
$ (allOf 2).height (anyOf 2)nullAlternative
$ (allOf 2).widthJSONOptional
$ (allOf 2).width (anyOf 1)numberAlternativeThe width of the photo. Read-only.
Format: int32
Maximum: 2147483647
Minimum: -2147483648
$ (allOf 2).width (anyOf 2)nullAlternative

Referenced models: Get rule — response body — @odata type, id

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type presence @odata type, activity, availability, id, out Of Office Settings, sequence Number, status Message, work Location

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).activityJSONOptional
$ (allOf 2).activity (anyOf 1)stringAlternativeThe supplemental information to a user's availability. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, Offline, OutOfOffice, PresenceUnknown.
$ (allOf 2).activity (anyOf 2)nullAlternative
$ (allOf 2).availabilityJSONOptional
$ (allOf 2).availability (anyOf 1)stringAlternativeThe base presence information for a user. Possible values are Available, Away, BeRightBack, Busy, DoNotDisturb, Focusing, InACall, InAMeeting, Offline, Presenting, PresenceUnknown.
$ (allOf 2).availability (anyOf 2)nullAlternative
$ (allOf 2).outOfOfficeSettingsJSONOptionalThe out of office settings for a user.
$ (allOf 2).outOfOfficeSettings (anyOf 1)ModelAlternativeExpand Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type presence @odata type, activity, availability, id, out Of Office Settings, sequence Number, status Message, work Location @odata type, activity, availability, out Of Office Settings, sequence Number, status Message, work Location out Of Office Settings @odata type, is Out Of Office, message
$ (allOf 2).outOfOfficeSettings (anyOf 2)JSONAlternative
$ (allOf 2).outOfOfficeSettings (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).outOfOfficeSettings (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).sequenceNumberJSONOptional
$ (allOf 2).sequenceNumber (anyOf 1)stringAlternativeThe lexicographically sortable String stamp that represents the version of a presence object.
Read only: true
$ (allOf 2).sequenceNumber (anyOf 2)nullAlternative
$ (allOf 2).statusMessageJSONOptionalThe presence status message of a user.
$ (allOf 2).statusMessage (anyOf 1)ModelAlternativeExpand Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type presence @odata type, activity, availability, id, out Of Office Settings, sequence Number, status Message, work Location @odata type, activity, availability, out Of Office Settings, sequence Number, status Message, work Location status Message @odata type, expiry Date Time, message, published Date Time
$ (allOf 2).statusMessage (anyOf 2)JSONAlternative
$ (allOf 2).statusMessage (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).statusMessage (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).workLocationJSONOptionalRepresents the user’s aggregated work location state.
$ (allOf 2).workLocation (anyOf 1)ModelAlternativeExpand Create User — request body — body / @odata.type, aboutMe, accountEnabled, activities, adhocCalls, ageGroup, agreementAcceptances, appRoleAssignments, assignedLicenses, assignedPlans, authentication, authorizationInfo, birthday, businessPhones, calendar, calendarGroups, calendarView, calendars, chats, city, cloudClipboard, cloudPCs, companyName, consentProvidedForMinor, contactFolders, contacts, country, createdDateTime, createdObjects, creationType, customSecurityAttributes, dataSecurityAndGovernance, department, deviceEnrollmentLimit, deviceManagementTroubleshootingEvents, directReports, displayName, drive, drives, employeeExperience, employeeHireDate, employeeId, employeeLeaveDateTime, employeeOrgData, employeeType, events, extensions, externalUserState, externalUserStateChangeDateTime, faxNumber, followedSites, givenName, hireDate, identities, identityParentId, imAddresses, inferenceClassification, insights, interests, isManagementRestricted, isResourceAccount, jobTitle, joinedTeams, lastPasswordChangeDateTime, legalAgeGroupClassification, licenseAssignmentStates, licenseDetails, mail, mailFolders, mailNickname, mailboxSettings, managedAppRegistrations, managedDevices, manager, memberOf, messages, mobilePhone, mySite, notes, oauth2PermissionGrants, officeLocation, onPremisesDistinguishedName, onPremisesDomainName, onPremisesExtensionAttributes, onPremisesImmutableId, onPremisesLastSyncDateTime, onPremisesProvisioningErrors, onPremisesSamAccountName, onPremisesSecurityIdentifier, onPremisesSyncBehavior, onPremisesSyncEnabled, onPremisesUserPrincipalName, onenote, onlineMeetings, otherMails, outlook, ownedDevices, ownedObjects, passwordPolicies, passwordProfile, pastProjects, people, permissionGrants, photo, photos, planner, postalCode, preferredDataLocation, preferredLanguage, preferredName, presence, print, provisionedPlans, proxyAddresses, registeredDevices, responsibilities, schools, scopedRoleMemberOf, securityIdentifier, serviceProvisioningErrors, settings, showInAddressList, signInActivity, signInSessionsValidFromDateTime, skills, solutions, sponsorOf, sponsors, state, streetAddress, surname, teamwork, todo, transitiveMemberOf, usageLocation, userPrincipalName, userType / presence / @odata.type, activity, availability, id, outOfOfficeSettings, sequenceNumber, statusMessage, workLocation / @odata.type, activity, availability, outOfOfficeSettings, sequenceNumber, statusMessage, workLocation / workLocation / source: none, manual, scheduled, automatic, unknown Future Value, work Location Type: unspecified, office, remote, time Off, unknown Future Value
$ (allOf 2).workLocation (anyOf 2)JSONAlternative
$ (allOf 2).workLocation (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).workLocation (anyOf 2) (anyOf 2)nullAlternative

Referenced models: Get rule — response body — @odata type, id, Create User — response body — @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type presence @odata type, activity, availability, id, out Of Office Settings, sequence Number, status Message, work Location @odata type, activity, availability, out Of Office Settings, sequence Number, status Message, work Location out Of Office Settings @odata type, is Out Of Office, message, Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type presence @odata type, activity, availability, id, out Of Office Settings, sequence Number, status Message, work Location @odata type, activity, availability, out Of Office Settings, sequence Number, status Message, work Location status Message @odata type, expiry Date Time, message, published Date Time, Create User — request body — body / @odata.type, aboutMe, accountEnabled, activities, adhocCalls, ageGroup, agreementAcceptances, appRoleAssignments, assignedLicenses, assignedPlans, authentication, authorizationInfo, birthday, businessPhones, calendar, calendarGroups, calendarView, calendars, chats, city, cloudClipboard, cloudPCs, companyName, consentProvidedForMinor, contactFolders, contacts, country, createdDateTime, createdObjects, creationType, customSecurityAttributes, dataSecurityAndGovernance, department, deviceEnrollmentLimit, deviceManagementTroubleshootingEvents, directReports, displayName, drive, drives, employeeExperience, employeeHireDate, employeeId, employeeLeaveDateTime, employeeOrgData, employeeType, events, extensions, externalUserState, externalUserStateChangeDateTime, faxNumber, followedSites, givenName, hireDate, identities, identityParentId, imAddresses, inferenceClassification, insights, interests, isManagementRestricted, isResourceAccount, jobTitle, joinedTeams, lastPasswordChangeDateTime, legalAgeGroupClassification, licenseAssignmentStates, licenseDetails, mail, mailFolders, mailNickname, mailboxSettings, managedAppRegistrations, managedDevices, manager, memberOf, messages, mobilePhone, mySite, notes, oauth2PermissionGrants, officeLocation, onPremisesDistinguishedName, onPremisesDomainName, onPremisesExtensionAttributes, onPremisesImmutableId, onPremisesLastSyncDateTime, onPremisesProvisioningErrors, onPremisesSamAccountName, onPremisesSecurityIdentifier, onPremisesSyncBehavior, onPremisesSyncEnabled, onPremisesUserPrincipalName, onenote, onlineMeetings, otherMails, outlook, ownedDevices, ownedObjects, passwordPolicies, passwordProfile, pastProjects, people, permissionGrants, photo, photos, planner, postalCode, preferredDataLocation, preferredLanguage, preferredName, presence, print, provisionedPlans, proxyAddresses, registeredDevices, responsibilities, schools, scopedRoleMemberOf, securityIdentifier, serviceProvisioningErrors, settings, showInAddressList, signInActivity, signInSessionsValidFromDateTime, skills, solutions, sponsorOf, sponsors, state, streetAddress, surname, teamwork, todo, transitiveMemberOf, usageLocation, userPrincipalName, userType / presence / @odata.type, activity, availability, id, outOfOfficeSettings, sequenceNumber, statusMessage, workLocation / @odata.type, activity, availability, outOfOfficeSettings, sequenceNumber, statusMessage, workLocation / workLocation / source: none, manual, scheduled, automatic, unknown Future Value, work Location Type: unspecified, office, remote, time Off, unknown Future Value

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type presence @odata type, activity, availability, id, out Of Office Settings, sequence Number, status Message, work Location @odata type, activity, availability, out Of Office Settings, sequence Number, status Message, work Location status Message @odata type, expiry Date Time, message, published Date Time

FieldTypePresenceDescription and constraints
$objectRoot
@odata.typestringOptional
expiryDateTimeJSONOptionalTime in which the status message expires.If not provided, the status message doesn't expire.expiryDateTime.dateTime shouldn't include time zone.expiryDateTime isn't available when you request the presence of another user.
expiryDateTime (anyOf 1)ModelAlternativeExpand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
expiryDateTime (anyOf 2)JSONAlternative
expiryDateTime (anyOf 2) (anyOf 1)objectAlternative
expiryDateTime (anyOf 2) (anyOf 2)nullAlternative
messageJSONOptionalStatus message item. The only supported format currently is message.contentType = 'text'.
message (anyOf 1)ModelAlternativeExpand Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type
message (anyOf 2)JSONAlternative
message (anyOf 2) (anyOf 1)objectAlternative
message (anyOf 2) (anyOf 2)nullAlternative
publishedDateTimeJSONOptional
publishedDateTime (anyOf 1)stringAlternativeTime in which the status message was published.Read-only.publishedDateTime isn't available when you request the presence of another user.
Format: date-time
Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
publishedDateTime (anyOf 2)nullAlternative

Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time, Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type settings @odata type, contribution To Content Discovery As Organization Disabled, contribution To Content Discovery Disabled, id

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).contributionToContentDiscoveryAsOrganizationDisabledbooleanOptionalReflects the organization level setting controlling delegate access to the trending API. When set to true, the organization doesn't have access to Office Delve. The relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected for the whole organization. This setting is read-only and can only be changed by administrators in the SharePoint admin center.
$ (allOf 2).contributionToContentDiscoveryDisabledbooleanOptionalWhen set to true, the delegate access to the user's trending API is disabled. When set to true, documents in the user's Office Delve are disabled. When set to true, the relevancy of the content displayed in Microsoft 365, for example in Suggested sites in SharePoint Home and the Discover view in OneDrive for work or school is affected. Users can control this setting in Office Delve.

Referenced models: Get rule — response body — @odata type, id

Create User — request body — body @odata type, about Me, account Enabled, activities, adhoc Calls, age Group, agreement Acceptances, app Role Assignments, assigned Licenses, assigned Plans, authentication, authorization Info, birthday, business Phones, calendar, calendar Groups, calendar View, calendars, chats, city, cloud Clipboard, cloud P Cs, company Name, consent Provided For Minor, contact Folders, contacts, country, created Date Time, created Objects, creation Type, custom Security Attributes, data Security And Governance, department, device Enrollment Limit, device Management Troubleshooting Events, direct Reports, display Name, drive, drives, employee Experience, employee Hire Date, employee Id, employee Leave Date Time, employee Org Data, employee Type, events, extensions, external User State, external User State Change Date Time, fax Number, followed Sites, given Name, hire Date, identities, identity Parent Id, im Addresses, inference Classification, insights, interests, is Management Restricted, is Resource Account, job Title, joined Teams, last Password Change Date Time, legal Age Group Classification, license Assignment States, license Details, mail, mail Folders, mail Nickname, mailbox Settings, managed App Registrations, managed Devices, manager, member Of, messages, mobile Phone, my Site, notes, oauth2 Permission Grants, office Location, on Premises Distinguished Name, on Premises Domain Name, on Premises Extension Attributes, on Premises Immutable Id, on Premises Last Sync Date Time, on Premises Provisioning Errors, on Premises Sam Account Name, on Premises Security Identifier, on Premises Sync Behavior, on Premises Sync Enabled, on Premises User Principal Name, onenote, online Meetings, other Mails, outlook, owned Devices, owned Objects, password Policies, password Profile, past Projects, people, permission Grants, photo, photos, planner, postal Code, preferred Data Location, preferred Language, preferred Name, presence, print, provisioned Plans, proxy Addresses, registered Devices, responsibilities, schools, scoped Role Member Of, security Identifier, service Provisioning Errors, settings, show In Address List, sign In Activity, sign In Sessions Valid From Date Time, skills, solutions, sponsor Of, sponsors, state, street Address, surname, teamwork, todo, transitive Member Of, usage Location, user Principal Name, user Type teamwork @odata type, id, locale, region

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).localeJSONOptional
$ (allOf 2).locale (anyOf 1)stringAlternativeRepresents the location that a user selected in Microsoft Teams and doesn't follow the Office's locale setting. A user's locale is represented by their preferred language and country or region. For example, en-us. The language component follows two-letter codes as defined in ISO 639-1, and the country component follows two-letter codes as defined in ISO 3166-1 alpha-2.
$ (allOf 2).locale (anyOf 2)nullAlternative
$ (allOf 2).regionJSONOptional
$ (allOf 2).region (anyOf 1)stringAlternativeRepresents the region of the organization or the user. For users with multigeo licenses, the property contains the user's region (if available). For users without multigeo licenses, the property contains the organization's region.The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.
$ (allOf 2).region (anyOf 2)nullAlternative

Referenced models: Get rule — response body — @odata type, id

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.