Skip to content

Office365usersClient

Classes

MyTrendingDocumentsResponse dataclass

MyTrendingDocumentsResponse(value: Optional[List[GraphTrending]] = None)

Response for Get my trending documents

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphTrending]] = None

value

LinklessEntityListResponseListPerson dataclass

LinklessEntityListResponseListPerson(value: Optional[List[Person]] = None)

Response for Get relevant people

Attributes

value class-attribute instance-attribute
value: Optional[List[Person]] = None

Value

ClientPhotoMetadata dataclass

ClientPhotoMetadata(has_photo: Optional[bool] = None, height: Optional[int] = None, width: Optional[int] = None, content_type: Optional[str] = None, image_file_extension: Optional[str] = None)

Response for Get user photo metadata

Attributes

has_photo class-attribute instance-attribute
has_photo: Optional[bool] = field(default=None, metadata={'wire_name': 'HasPhoto'})

Has photo

height class-attribute instance-attribute
height: Optional[int] = field(default=None, metadata={'wire_name': 'Height'})

Height of photo

width class-attribute instance-attribute
width: Optional[int] = field(default=None, metadata={'wire_name': 'Width'})

Width of photo

content_type class-attribute instance-attribute
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

Content Type of photo

image_file_extension class-attribute instance-attribute
image_file_extension: Optional[str] = field(default=None, metadata={'wire_name': 'ImageFileExtension'})

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

TrendingDocumentsResponse dataclass

TrendingDocumentsResponse(value: Optional[List[GraphTrending]] = None)

Response for Get trending documents

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphTrending]] = None

value

ObjectWithoutType dataclass

ObjectWithoutType(additional_properties: Dict[str, Any] = dict())

Response for Send an HTTP request

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

DirectReportsResponse dataclass

DirectReportsResponse(value: Optional[List[GraphUser]] = None)

Response for Get direct reports

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphUser]] = None

Value

GraphUser dataclass

GraphUser(about_me: Optional[str] = None, account_enabled: Optional[bool] = None, birthday: Optional[str] = None, business_phones: Optional[List[str]] = None, city: Optional[str] = None, company_name: Optional[str] = None, country: Optional[str] = None, department: Optional[str] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, hire_date: Optional[str] = None, id: Optional[str] = None, interests: Optional[List[str]] = None, job_title: Optional[str] = None, mail: Optional[str] = None, mail_nickname: Optional[str] = None, mobile_phone: Optional[str] = None, my_site: Optional[str] = None, office_location: Optional[str] = None, past_projects: Optional[List[str]] = None, postal_code: Optional[str] = None, preferred_language: Optional[str] = None, preferred_name: Optional[str] = None, responsibilities: Optional[List[str]] = None, schools: Optional[List[str]] = None, skills: Optional[List[str]] = None, state: Optional[str] = None, street_address: Optional[str] = None, surname: Optional[str] = None, user_principal_name: Optional[str] = None, user_type: Optional[str] = None)

Response for Get manager

Attributes

about_me class-attribute instance-attribute
about_me: Optional[str] = field(default=None, metadata={'wire_name': 'aboutMe'})

About Me

account_enabled class-attribute instance-attribute
account_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'accountEnabled'})

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

birthday class-attribute instance-attribute
birthday: Optional[str] = None

Birthday

business_phones class-attribute instance-attribute
business_phones: Optional[List[str]] = field(default=None, metadata={'wire_name': 'businessPhones'})

Business Phones

city class-attribute instance-attribute
city: Optional[str] = None

The city in which the user is located.

company_name class-attribute instance-attribute
company_name: Optional[str] = field(default=None, metadata={'wire_name': 'companyName'})

The name of the company in which the user works.

country class-attribute instance-attribute
country: Optional[str] = None

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

department class-attribute instance-attribute
department: Optional[str] = None

The name of the department in which the user works.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Display Name

given_name class-attribute instance-attribute
given_name: Optional[str] = field(default=None, metadata={'wire_name': 'givenName'})

Given Name

hire_date class-attribute instance-attribute
hire_date: Optional[str] = field(default=None, metadata={'wire_name': 'hireDate'})

Hire Date

id class-attribute instance-attribute
id: Optional[str] = None

Id

interests class-attribute instance-attribute
interests: Optional[List[str]] = None

Interests

job_title class-attribute instance-attribute
job_title: Optional[str] = field(default=None, metadata={'wire_name': 'jobTitle'})

Job Title

mail class-attribute instance-attribute
mail: Optional[str] = None

Mail

mail_nickname class-attribute instance-attribute
mail_nickname: Optional[str] = field(default=None, metadata={'wire_name': 'mailNickname'})

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

mobile_phone class-attribute instance-attribute
mobile_phone: Optional[str] = field(default=None, metadata={'wire_name': 'mobilePhone'})

Mobile Phone

my_site class-attribute instance-attribute
my_site: Optional[str] = field(default=None, metadata={'wire_name': 'mySite'})

My Site

office_location class-attribute instance-attribute
office_location: Optional[str] = field(default=None, metadata={'wire_name': 'officeLocation'})

Office Location

past_projects class-attribute instance-attribute
past_projects: Optional[List[str]] = field(default=None, metadata={'wire_name': 'pastProjects'})

Past Projects

postal_code class-attribute instance-attribute
postal_code: Optional[str] = field(default=None, metadata={'wire_name': 'postalCode'})

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.

preferred_language class-attribute instance-attribute
preferred_language: Optional[str] = field(default=None, metadata={'wire_name': 'preferredLanguage'})

Preferred Language

preferred_name class-attribute instance-attribute
preferred_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredName'})

Preferred Name

responsibilities class-attribute instance-attribute
responsibilities: Optional[List[str]] = None

Responsibilities

schools class-attribute instance-attribute
schools: Optional[List[str]] = None

Schools

skills class-attribute instance-attribute
skills: Optional[List[str]] = None

Skills

state class-attribute instance-attribute
state: Optional[str] = None

State

street_address class-attribute instance-attribute
street_address: Optional[str] = field(default=None, metadata={'wire_name': 'streetAddress'})

Street Address

surname class-attribute instance-attribute
surname: Optional[str] = None

Surname

user_principal_name class-attribute instance-attribute
user_principal_name: Optional[str] = field(default=None, metadata={'wire_name': 'userPrincipalName'})

User Principal Name

user_type class-attribute instance-attribute
user_type: Optional[str] = field(default=None, metadata={'wire_name': 'userType'})

User Type

EntityListResponseIReadOnlyListUser dataclass

EntityListResponseIReadOnlyListUser(value: Optional[List[User]] = None, next_link: Optional[str] = None)

Response for Search for users

Attributes

value class-attribute instance-attribute
value: Optional[List[User]] = None

Value

next_link: Optional[str] = field(default=None, metadata={'wire_name': '@odata.nextLink'})

Next page link

GraphUserUpdateable dataclass

GraphUserUpdateable(about_me: Optional[str] = None, birthday: Optional[str] = None, interests: Optional[List[str]] = None, my_site: Optional[str] = None, past_projects: Optional[List[str]] = None, schools: Optional[List[str]] = None, skills: Optional[List[str]] = None)

Definition: GraphUserUpdateable

Attributes

about_me class-attribute instance-attribute
about_me: Optional[str] = field(default=None, metadata={'wire_name': 'aboutMe'})

About Me

birthday class-attribute instance-attribute
birthday: Optional[str] = None

Birthday

interests class-attribute instance-attribute
interests: Optional[List[str]] = None

Interests

my_site class-attribute instance-attribute
my_site: Optional[str] = field(default=None, metadata={'wire_name': 'mySite'})

My Site

past_projects class-attribute instance-attribute
past_projects: Optional[List[str]] = field(default=None, metadata={'wire_name': 'pastProjects'})

Past Projects

schools class-attribute instance-attribute
schools: Optional[List[str]] = None

Schools

skills class-attribute instance-attribute
skills: Optional[List[str]] = None

Skills

GraphTrending dataclass

GraphTrending(id: Optional[str] = None, weight: Optional[float] = None, resource_visualization: Optional[ResourceVisualization] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Definition: GraphTrending

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

Unique identifier of the relationship

weight class-attribute instance-attribute
weight: Optional[float] = None

Value indicating how much the document is currently trending

ResourceVisualization dataclass

ResourceVisualization(title: Optional[str] = None, type_: Optional[str] = None, media_type: Optional[str] = None, preview_image_url: Optional[str] = None, preview_text: Optional[str] = None, container_web_url: Optional[str] = None, container_display_name: Optional[str] = None, container_type: Optional[str] = None)

Definition: resourceVisualization

Attributes

title class-attribute instance-attribute
title: Optional[str] = None

The item's title text

type_ class-attribute instance-attribute
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

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

media_type class-attribute instance-attribute
media_type: Optional[str] = field(default=None, metadata={'wire_name': 'mediaType'})

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

preview_image_url class-attribute instance-attribute
preview_image_url: Optional[str] = field(default=None, metadata={'wire_name': 'previewImageUrl'})

A URL leading to the preview image for the item

preview_text class-attribute instance-attribute
preview_text: Optional[str] = field(default=None, metadata={'wire_name': 'previewText'})

A preview text for the item

container_web_url class-attribute instance-attribute
container_web_url: Optional[str] = field(default=None, metadata={'wire_name': 'containerWebUrl'})

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

container_display_name class-attribute instance-attribute
container_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'containerDisplayName'})

A string describing where the item is stored

container_type class-attribute instance-attribute
container_type: Optional[str] = field(default=None, metadata={'wire_name': 'containerType'})

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

SensitivityLabelMetadata dataclass

SensitivityLabelMetadata(sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: sensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute
sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute
name: Optional[str] = None

SensitivityLabel name.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

SensitivityLabel displayName info

tooltip class-attribute instance-attribute
tooltip: Optional[str] = None

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute
priority: Optional[int] = None

SensitivityLabel priority.

color class-attribute instance-attribute
color: Optional[str] = None

SensitivityLabel color.

is_encrypted class-attribute instance-attribute
is_encrypted: Optional[bool] = field(default=None, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute
is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute
is_parent: Optional[bool] = field(default=None, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute
parent_sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

Person dataclass

Person(id: Optional[str] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, surname: Optional[str] = None, birthday: Optional[str] = None, person_notes: Optional[str] = None, is_favorite: Optional[bool] = None, job_title: Optional[str] = None, company_name: Optional[str] = None, department: Optional[str] = None, office_location: Optional[str] = None, profession: Optional[str] = None, user_principal_name: Optional[str] = None, im_address: Optional[str] = None, scored_email_addresses: Optional[List[ScoredEmailAddress]] = None, phones: Optional[List[Phone]] = None)

Definition: Person

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

A unique identifier for the Person object in the directory

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The person's display name

given_name class-attribute instance-attribute
given_name: Optional[str] = field(default=None, metadata={'wire_name': 'givenName'})

The person's given name

surname class-attribute instance-attribute
surname: Optional[str] = None

The person's surname

birthday class-attribute instance-attribute
birthday: Optional[str] = None

The person's birthday

person_notes class-attribute instance-attribute
person_notes: Optional[str] = field(default=None, metadata={'wire_name': 'personNotes'})

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

is_favorite class-attribute instance-attribute
is_favorite: Optional[bool] = field(default=None, metadata={'wire_name': 'isFavorite'})

If the current user has flagged this person as a favorite

job_title class-attribute instance-attribute
job_title: Optional[str] = field(default=None, metadata={'wire_name': 'jobTitle'})

The person's job title

company_name class-attribute instance-attribute
company_name: Optional[str] = field(default=None, metadata={'wire_name': 'companyName'})

The name of the person's company

department class-attribute instance-attribute
department: Optional[str] = None

The person's department

office_location class-attribute instance-attribute
office_location: Optional[str] = field(default=None, metadata={'wire_name': 'officeLocation'})

The location of the person's office

profession class-attribute instance-attribute
profession: Optional[str] = None

The person's profession

user_principal_name class-attribute instance-attribute
user_principal_name: Optional[str] = field(default=None, metadata={'wire_name': 'userPrincipalName'})

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.

im_address class-attribute instance-attribute
im_address: Optional[str] = field(default=None, metadata={'wire_name': 'imAddress'})

The person's VOIP SIP address

scored_email_addresses class-attribute instance-attribute
scored_email_addresses: Optional[List[ScoredEmailAddress]] = field(default=None, metadata={'wire_name': 'scoredEmailAddresses'})

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

phones class-attribute instance-attribute
phones: Optional[List[Phone]] = None

The person's phone numbers

ScoredEmailAddress dataclass

ScoredEmailAddress(address: Optional[str] = None, relevance_score: Optional[float] = None)

Definition: ScoredEmailAddress

Attributes

address class-attribute instance-attribute
address: Optional[str] = None

The email address

relevance_score class-attribute instance-attribute
relevance_score: Optional[float] = field(default=None, metadata={'wire_name': 'relevanceScore'})

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.

Phone dataclass

Phone(number: Optional[str] = None, type_: Optional[str] = None)

Definition: Phone

Attributes

number class-attribute instance-attribute
number: Optional[str] = None

The phone number

type_ class-attribute instance-attribute
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

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

User dataclass

User(id: Optional[str] = None, account_enabled: Optional[bool] = None, business_phones: Optional[List[str]] = None, city: Optional[str] = None, company_name: Optional[str] = None, country: Optional[str] = None, department: Optional[str] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, job_title: Optional[str] = None, mail: Optional[str] = None, mail_nickname: Optional[str] = None, mobile_phone: Optional[str] = None, office_location: Optional[str] = None, postal_code: Optional[str] = None, surname: Optional[str] = None, telephone_number: Optional[str] = None, user_principal_name: Optional[str] = None)

Definition: User

Attributes

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

A unique identifier for the user object in the directory.

account_enabled class-attribute instance-attribute
account_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'AccountEnabled'})

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

business_phones class-attribute instance-attribute
business_phones: Optional[List[str]] = field(default=None, metadata={'wire_name': 'BusinessPhones'})

A list of business phone numbers for the user

city class-attribute instance-attribute
city: Optional[str] = field(default=None, metadata={'wire_name': 'City'})

The city in which the user is located.

company_name class-attribute instance-attribute
company_name: Optional[str] = field(default=None, metadata={'wire_name': 'CompanyName'})

The name of the company in which the user works.

country class-attribute instance-attribute
country: Optional[str] = field(default=None, metadata={'wire_name': 'Country'})

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

department class-attribute instance-attribute
department: Optional[str] = field(default=None, metadata={'wire_name': 'Department'})

The name of the department in which the user works.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

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.

given_name class-attribute instance-attribute
given_name: Optional[str] = field(default=None, metadata={'wire_name': 'GivenName'})

The given name (first name) of the user.

job_title class-attribute instance-attribute
job_title: Optional[str] = field(default=None, metadata={'wire_name': 'JobTitle'})

The user's job title.

mail class-attribute instance-attribute
mail: Optional[str] = field(default=None, metadata={'wire_name': 'Mail'})

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

mail_nickname class-attribute instance-attribute
mail_nickname: Optional[str] = field(default=None, metadata={'wire_name': 'MailNickname'})

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

mobile_phone class-attribute instance-attribute
mobile_phone: Optional[str] = field(default=None, metadata={'wire_name': 'mobilePhone'})

The primary cellular telephone number for the user.

office_location class-attribute instance-attribute
office_location: Optional[str] = field(default=None, metadata={'wire_name': 'OfficeLocation'})

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

postal_code class-attribute instance-attribute
postal_code: Optional[str] = field(default=None, metadata={'wire_name': 'PostalCode'})

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 class-attribute instance-attribute
surname: Optional[str] = field(default=None, metadata={'wire_name': 'Surname'})

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

telephone_number class-attribute instance-attribute
telephone_number: Optional[str] = field(default=None, metadata={'wire_name': 'TelephoneNumber'})

The primary cellular telephone number for the user.

user_principal_name class-attribute instance-attribute
user_principal_name: Optional[str] = field(default=None, metadata={'wire_name': 'UserPrincipalName'})

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.

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Office365usersClient

Office365usersClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for office365users connector.

Initialize a Office365usersClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

None
options Optional[ConnectorClientOptions]

Optional connector client options.

None

Methods:

update_my_profile_async async
update_my_profile_async(input: GraphUserUpdateable) -> None

Update my profile

Updates the profile of the current user

update_my_photo_async async
update_my_photo_async(input: bytes) -> None

Update my profile photo

Updates the profile photo of the current user. The size of the photo must be less than 4 MB.

my_trending_documents_async(filter: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get my trending documents

Retrieves the trending documents for the signed in user

relevant_people_async async
relevant_people_async(user_id: str) -> dict[str, Any] | None

Get relevant people

Get relevant people.

user_photo_metadata_async async
user_photo_metadata_async(user_id: str) -> dict[str, Any] | None

Get user photo metadata

Get user photo metadata.

trending_documents_async async
trending_documents_async(id: str, filter: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get trending documents

Retrieves the trending documents for a user

http_request_async async
http_request_async(input: bytes) -> dict[str, Any] | None

Send an HTTP request

Construct a Microsoft Graph REST API request to invoke. These segments are supported: 1st segement: /me, /users/ 2nd segment: messages, mailFolders, events, calendar, calendars, outlook, inferenceClassification. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api.

direct_reports_async async
direct_reports_async(id: str, select: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

Get direct reports

Retrieves the user profiles of the specified user's direct reports. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties

manager_async async
manager_async(id: str, select: Optional[str] = None) -> dict[str, Any] | None

Get manager

Retrieves the profile of the specified user's manager. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties

my_profile_async async
my_profile_async(select: Optional[str] = None) -> dict[str, Any] | None

Get my profile

Retrieves the profile of the current user. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties

search_user_async async
search_user_async(search_term: Optional[str] = None, top: Optional[int] = None, is_search_term_required: Optional[bool] = None) -> dict[str, Any] | None

Search for users

Retrieves the user profiles that match the search term.

user_photo_async async
user_photo_async(id: str) -> bytes

Get user photo

Retrieves the photo of the specified user if they have one

user_profile_async async
user_profile_async(id: str, select: Optional[str] = None) -> dict[str, Any] | None

Get user profile

Retrieves the profile of a specific user. Learn more about available fields to select: https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties