Office365usersClient
Classes
MyTrendingDocumentsResponse
dataclass
LinklessEntityListResponseListPerson
dataclass
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
height
class-attribute
instance-attribute
Height of photo
width
class-attribute
instance-attribute
Width of photo
content_type
class-attribute
instance-attribute
Content Type of photo
TrendingDocumentsResponse
dataclass
ObjectWithoutType
dataclass
DirectReportsResponse
dataclass
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
account_enabled
class-attribute
instance-attribute
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'})
Business Phones
city
class-attribute
instance-attribute
The city in which the user is located.
company_name
class-attribute
instance-attribute
The name of the company in which the user works.
country
class-attribute
instance-attribute
The country/region in which the user is located; for example, "US" or "UK".
department
class-attribute
instance-attribute
The name of the department in which the user works.
display_name
class-attribute
instance-attribute
Display Name
given_name
class-attribute
instance-attribute
Given Name
hire_date
class-attribute
instance-attribute
Hire Date
job_title
class-attribute
instance-attribute
Job Title
mail_nickname
class-attribute
instance-attribute
The mail alias for the user. This property must be specified when a user is created.
mobile_phone
class-attribute
instance-attribute
Mobile Phone
my_site
class-attribute
instance-attribute
My Site
office_location
class-attribute
instance-attribute
Office Location
past_projects
class-attribute
instance-attribute
Past Projects
postal_code
class-attribute
instance-attribute
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
responsibilities
class-attribute
instance-attribute
Responsibilities
street_address
class-attribute
instance-attribute
Street Address
EntityListResponseIReadOnlyListUser
dataclass
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
my_site
class-attribute
instance-attribute
My Site
past_projects
class-attribute
instance-attribute
Past Projects
GraphTrending
dataclass
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
type_
class-attribute
instance-attribute
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
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
A URL leading to the preview image for the item
preview_text
class-attribute
instance-attribute
A preview text for the item
container_web_url
class-attribute
instance-attribute
A path leading to the folder in which the item 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.
display_name
class-attribute
instance-attribute
SensitivityLabel displayName info
tooltip
class-attribute
instance-attribute
SensitivityLabel details on tooltip.
priority
class-attribute
instance-attribute
SensitivityLabel priority.
is_encrypted
class-attribute
instance-attribute
is SensitivityLabel Encrypted.
is_enabled
class-attribute
instance-attribute
Whether SensitivityLabel is Enabled.
is_parent
class-attribute
instance-attribute
Whether SensitivityLabel is Parent.
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
A unique identifier for the Person object in the directory
display_name
class-attribute
instance-attribute
The person's display name
given_name
class-attribute
instance-attribute
The person's given name
person_notes
class-attribute
instance-attribute
Free-form notes that the current user has taken about this person
is_favorite
class-attribute
instance-attribute
If the current user has flagged this person as a favorite
job_title
class-attribute
instance-attribute
The person's job title
company_name
class-attribute
instance-attribute
The name of the person's company
department
class-attribute
instance-attribute
The person's department
office_location
class-attribute
instance-attribute
The location of the person's office
profession
class-attribute
instance-attribute
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
The person's VOIP SIP address
ScoredEmailAddress
dataclass
Definition: ScoredEmailAddress
Attributes
relevance_score
class-attribute
instance-attribute
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
Definition: Phone
Attributes
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
A unique identifier for the user object in the directory.
account_enabled
class-attribute
instance-attribute
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
The city in which the user is located.
company_name
class-attribute
instance-attribute
The name of the company in which the user works.
country
class-attribute
instance-attribute
The country/region in which the user is located; for example, "US" or "UK".
department
class-attribute
instance-attribute
The name of the department in which the user works.
display_name
class-attribute
instance-attribute
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
The given name (first name) of the user.
job_title
class-attribute
instance-attribute
The user's job title.
mail
class-attribute
instance-attribute
The SMTP/email address for the user, for example, "jeff@contoso.onmicrosoft.com". Read-Only.
mail_nickname
class-attribute
instance-attribute
The mail alias for the user. This property must be specified when a user is created.
mobile_phone
class-attribute
instance-attribute
The primary cellular telephone number for the user.
office_location
class-attribute
instance-attribute
The office location in the user's place of business.
postal_code
class-attribute
instance-attribute
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
The user's surname (family name or last name).
telephone_number
class-attribute
instance-attribute
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
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
Updates the profile of the current user
update_my_photo_async
async
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
async
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
Get relevant people
Get relevant people.
user_photo_metadata_async
async
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
Send an HTTP request
Construct a Microsoft Graph REST API request to invoke. These segments
are supported: 1st segement: /me, /users/
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
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
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
Get user photo
Retrieves the photo of the specified user if they have one
user_profile_async
async
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