Office 365 Users

Status: Production

Tier: Standard

Version: 1.0

Name

Summary

UpdateMyProfile ([Optional]GraphUserUpdateable_V1 body)

Update my profile

MyProfile_V2 ([advanced][Optional]string $select)

Get my profile (V2)

UpdateMyPhoto (string body, [advanced]string Content-Type)

Update my profile photo

MyTrendingDocuments ([Optional]string $filter)

Get my trending documents

RelevantPeople (string userId)

Get relevant people

MyProfile ()

Get my profile (V1)

UserProfile (string userId)

Get user profile (V1)

UserPhotoMetadata (string userId)

Get user photo metadata

UserPhoto (string userId)

Get user photo (V1)

Manager (string userId)

Get manager (V1)

DirectReports (string userId)

Get direct reports (V1)

SearchUser ([Optional]string searchTerm, [advanced][Optional]integer top)

Search for users

SearchUserV2 ([Optional]string searchTerm, [advanced][Optional]integer top, [internal][Optional]string skipToken)

Search for users (V2)

TestConnection ()

Tests the connection

UserProfile_V2 (string id, [advanced][Optional]string $select)

Get user profile (V2)

Manager_V2 (string id, [advanced][Optional]string $select)

Get manager (V2)

DirectReports_V2 (string id, [advanced][Optional]string $select, [advanced][Optional]integer $top)

Get direct reports (V2)

UserPhoto_V2 (string id)

Get user photo (V2)

TrendingDocuments (string id, [Optional]string $filter)

Get trending documents

Name

Summary

Name

Summary

ClientPhotoMetadata

DirectReports_V2Response

EntityListResponse[IReadOnlyList[User]]

GraphTrending

GraphUserUpdateable_V1

GraphUser_V1

LinklessEntityListResponse[List[Person]]

MyTrendingDocumentsResponse

Person

Phone

resourceReference

Resource reference

resourceVisualization

Resource visualization

ScoredEmailAddress

TrendingDocumentsResponse

User

Name

Type

Summary

Required

Related Action

body

GraphUserUpdateable_V1

Updateable parts of user from Graph API

False

Name

Type

Summary

Required

Related Action

$select

string

(Select fields)

Comma separated list of fields to select. Example: surname, department, jobTitle

False

Name

Type

Summary

Required

Related Action

body

string(binary)

True

Content-Type

string

(Content-Type)

Image content type (like 'image/jpeg')

True

Name

Type

Summary

Required

Related Action

$filter

string

(Filter query)

An OData filter to filter the resources selected. Filter selected resources on ResourceVisualization/Type or ResourceVisualization/containerType

False

Name

Type

Summary

Required

Related Action

userId

string

(User (UPN))

User principal name or email id.

True

Name

Type

Summary

Required

Related Action

userId

string

(User (UPN))

User principal name or email id.

True

Name

Type

Summary

Required

Related Action

userId

string

(User (UPN))

User principal name or email id.

True

Name

Type

Summary

Required

Related Action

userId

string

(User (UPN))

User principal name or email id.

True

Name

Type

Summary

Required

Related Action

userId

string

(User (UPN))

User principal name or email id.

True

Name

Type

Summary

Required

Related Action

userId

string

(User (UPN))

User principal name or email id.

True

Name

Type

Summary

Required

Related Action

searchTerm

string

(Search term)

Search string (applies to: display name, given name, surname, mail, mail nickname and user principal name).

False

top

integer(int32)

(Top)

Limit on the number of results to return. By default returns all entries.

False

Name

Type

Summary

Required

Related Action

searchTerm

string

(Search term)

Search string (applies to: display name, given name, surname, mail, mail nickname and user principal name). If not provided then no filtering will be applied.

False

top

integer(int32)

(Top)

Limit on the number of results to return. Minimum value is 1. Default value is 1000.

False

skipToken

string

(Skip token)

Skip token to get next users.

False

Name

Type

Summary

Required

Related Action

id

string

(User (UPN))

User principal name or email id

True

$select

string

(Select fields)

Comma separated list of fields to select. Example: surname, department, jobTitle

False

Name

Type

Summary

Required

Related Action

id

string

(User (UPN))

User principal name or email id

True

$select

string

(Select fields)

Comma separated list of fields to select. Example: surname, department, jobTitle

False

Name

Type

Summary

Required

Related Action

id

string

(User (UPN))

User principal name or email id

True

$select

string

(Select fields)

Comma separated list of fields to select. Example: surname, department, jobTitle

False

$top

integer(int32)

(Top)

Limit on the number of results to return. By default returns all entries.

False

Name

Type

Summary

Required

Related Action

id

string

(User (UPN))

User principal name or email id

True

Name

Type

Summary

Required

Related Action

id

string

(User (UPN))

User principal name or email id

True

$filter

string

(Filter query)

An OData filter to filter the resources selected. Filter selected resources on ResourceVisualization/Type or ResourceVisualization/containerType

False

Name

Type

Summary

HasPhoto

boolean

Has photo

Has photo

Height

integer(int32)

Height

Height of photo

Width

integer(int32)

Width

Width of photo

ContentType

string

ContentType

Content Type of photo

ImageFileExtension

string

Image File Extension

File extension for the photo (ex: ".jpg")

Name

Type

Summary

value

array of (GraphUser_V1)

Value

Name

Type

Summary

value

array of (User)

Value

@odata.nextLink

string

Next page link

Name

Type

Summary

id

string

Id

Unique identifier of the relationship

weight

number(float)

Weight

Value indicating how much the document is currently trending

resourceVisualization

resourceVisualization

Resource visualization

resourceVisualization

resourceReference

resourceReference

Resource reference

resourceReference

Name

Type

Summary

aboutMe

string

About Me

About Me

birthday

string(date-time)

Birthday

Birthday

interests

array of (string)

Interests

Interests

mySite

string

My Site

My Site

pastProjects

array of (string)

Past Projects

Past Projects

schools

array of (string)

Schools

Schools

skills

array of (string)

Skills

Skills

Name

Type

Summary

aboutMe

string

About Me

About Me

accountEnabled

boolean

Account enabled?

true if the account is enabled; otherwise, false. This property is required when a user is created.

birthday

string(date-time)

Birthday

Birthday

businessPhones

array of (string)

Business Phones

Business Phones

city

string

City

The city in which the user is located.

companyName

string

Company name

The name of the company in which the user works.

country

string

Country

The country/region in which the user is located; for example, "US" or "UK".

department

string

Department

The name of the department in which the user works.

displayName

string

Display Name

Display Name

givenName

string

Given Name

Given Name

hireDate

string(date-time)

Hire Date

Hire Date

id

string

Id

Id

interests

array of (string)

Interests

Interests

jobTitle

string

Job Title

Job Title

mail

string

Mail

Mail

mailNickname

string

Nickname

The mail alias for the user. This property must be specified when a user is created.

mobilePhone

string

Mobile Phone

Mobile Phone

mySite

string

My Site

My Site

officeLocation

string

Office Location

Office Location

pastProjects

array of (string)

Past Projects

Past Projects

postalCode

string

Postal code

The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.

preferredLanguage

string

Preferred Language

Preferred Language

preferredName

string

Preferred Name

Preferred Name

responsibilities

array of (string)

Responsibilities

Responsibilities

schools

array of (string)

Schools

Schools

skills

array of (string)

Skills

Skills

state

string

State

State

streetAddress

string

Street Address

Street Address

surname

string

Surname

Surname

userPrincipalName

string

User Principal Name

User Principal Name

userType

string

User Type

User Type

Name

Type

Summary

value

array of (Person)

Value

Name

Type

Summary

value

array of (GraphTrending)

value

value

Name

Type

Summary

id

string

Person id

A unique identifier for the Person object in the directory

displayName

string

Display name

The person's display name

givenName

string

Given name

The person's given name

surname

string

Surname

The person's surname

birthday

string

Birthday

The person's birthday

personNotes

string

Person Notes

Free-form notes that the current user has taken about this person

isFavorite

boolean

Is Favorite?

If the current user has flagged this person as a favorite

jobTitle

string

Job title

The person's job title

companyName

string

Company name

The name of the person's company

department

string

Department

The person's department

officeLocation

string

Office location

The location of the person's office

profession

string

Profession

The person's profession

userPrincipalName

string

User Principal Name (UPN)

The user principal name(UPN) of the user.The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name.The general format is alias @domain, where domain must be present in the tenant's collection of verified domains.

imAddress

string

IM Address

The person's VOIP SIP address

scoredEmailAddresses

array of (ScoredEmailAddress)

Scored Email Addresses

Collection of the person's email addresses with a relevance score

phones

array of (Phone)

Phones

The person's phone numbers

Name

Type

Summary

number

string

Phone Number

The phone number

type

string

Phone Type

The type of phone number. Possible values: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio.

Name

Type

Summary

webUrl

string

Web URL

A URL leading to the referenced item

id

string

Id

The item's unique identifier

type

string

Type

A string value that can be used to classify the item, such as "microsoft.graph.driveItem"

Name

Type

Summary

title

string

Title

The item's title text

type

string

Type

The item's media type (can be used for filtering for a specific file based on a specific type)

mediaType

string

Media type

The items media type (can be used for filtering for a specific type of file based on supported IANA Media MIME types)

previewImageUrl

string

Preview image URL

A URL leading to the preview image for the item

previewText

string

Preview text

A preview text for the item

containerWebUrl

string

Container web URL

A path leading to the folder in which the item is stored

containerDisplayName

string

Container display name

A string describing where the item is stored

containerType

string

Container type

Can be used for filtering by the type of container in which the file is stored

Name

Type

Summary

address

string

Email Address

The email address

relevanceScore

number(double)

Relevance Score

The 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.

Name

Type

Summary

value

array of (GraphTrending)

value

value

Name

Type

Summary

Id

string

User id

A unique identifier for the user object in the directory.

AccountEnabled

boolean

Account enabled?

true if the account is enabled; otherwise, false. This property is required when a user is created.

BusinessPhones

array of (string)

Business phones

A list of business phone numbers for the user

City

string

City

The city in which the user is located.

CompanyName

string

Company name

The name of the company in which the user works.

Country

string

Country

The country/region in which the user is located; for example, "US" or "UK".

Department

string

Department

The name of the department in which the user works.

DisplayName

string

Display name

The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates.

GivenName

string

Given name

The given name (first name) of the user.

JobTitle

string

Job title

The user’s job title.

Mail

string

Email

The SMTP/email address for the user, for example, "jeff@contoso.onmicrosoft.com". Read-Only.

MailNickname

string

Nickname

The mail alias for the user. This property must be specified when a user is created.

mobilePhone

string

The primary cellular telephone number for the user.

OfficeLocation

string

Office location

The office location in the user's place of business.

PostalCode

string

Postal code

The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code.

Surname

string

Surname

The user's surname (family name or last name).

TelephoneNumber

string

Telephone number

The primary cellular telephone number for the user.

UserPrincipalName

string

User Principal Name (UPN)

The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user’s email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains.