Office365usersClient
Classes
dataclass
dataclass
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
class-attribute
instance-attribute
has_photo: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasPhoto'})
Has photo
class-attribute
instance-attribute
height: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Height'})
Height of photo
class-attribute
instance-attribute
Width of photo
dataclass
dataclass
dataclass
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
class-attribute
instance-attribute
about_me: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'aboutMe'})
About Me
class-attribute
instance-attribute
account_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountEnabled'})
true if the account is enabled; otherwise, false. This property is required when a user is created.
class-attribute
instance-attribute
Birthday
class-attribute
instance-attribute
business_phones: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'businessPhones'})
Business Phones
class-attribute
instance-attribute
The city in which the user is located.
class-attribute
instance-attribute
company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'companyName'})
The name of the company in which the user works.
class-attribute
instance-attribute
The country/region in which the user is located; for example, "US" or "UK".
class-attribute
instance-attribute
The name of the department in which the user works.
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
Display Name
class-attribute
instance-attribute
given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'givenName'})
Given Name
class-attribute
instance-attribute
hire_date: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hireDate'})
Hire Date
class-attribute
instance-attribute
Id
class-attribute
instance-attribute
Interests
class-attribute
instance-attribute
job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})
Job Title
class-attribute
instance-attribute
class-attribute
instance-attribute
mail_nickname: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mailNickname'})
The mail alias for the user. This property must be specified when a user is created.
class-attribute
instance-attribute
mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})
Mobile Phone
class-attribute
instance-attribute
my_site: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mySite'})
My Site
class-attribute
instance-attribute
office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})
Office Location
class-attribute
instance-attribute
past_projects: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pastProjects'})
Past Projects
class-attribute
instance-attribute
postal_code: Optional[str] = dataclass_field(default=None, kw_only=True, 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.
class-attribute
instance-attribute
preferred_language: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'preferredLanguage'})
Preferred Language
class-attribute
instance-attribute
preferred_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'preferredName'})
Preferred Name
class-attribute
instance-attribute
Responsibilities
class-attribute
instance-attribute
Schools
class-attribute
instance-attribute
Skills
class-attribute
instance-attribute
State
class-attribute
instance-attribute
street_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'streetAddress'})
Street Address
class-attribute
instance-attribute
Surname
dataclass
EntityListResponseIReadOnlyListUser(*, value: Optional[List[User | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
Response for Search for users
Attributes
class-attribute
instance-attribute
Value
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
class-attribute
instance-attribute
about_me: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'aboutMe'})
About Me
class-attribute
instance-attribute
Birthday
class-attribute
instance-attribute
Interests
class-attribute
instance-attribute
my_site: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mySite'})
My Site
class-attribute
instance-attribute
past_projects: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'pastProjects'})
Past Projects
class-attribute
instance-attribute
Schools
dataclass
GraphTrending(*, id: Optional[str] = None, weight: Optional[float] = None, resource_visualization: Optional[ResourceVisualization | Mapping[str, Any]] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = None)
Definition: GraphTrending
Attributes
class-attribute
instance-attribute
Unique identifier of the relationship
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
class-attribute
instance-attribute
The item's title text
class-attribute
instance-attribute
The item's media type (can be used for filtering for a specific file based on a specific type)
class-attribute
instance-attribute
media_type: Optional[str] = dataclass_field(default=None, kw_only=True, 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)
class-attribute
instance-attribute
preview_image_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'previewImageUrl'})
A URL leading to the preview image for the item
class-attribute
instance-attribute
preview_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'previewText'})
A preview text for the item
class-attribute
instance-attribute
container_web_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'containerWebUrl'})
A path leading to the folder in which the item is stored
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
class-attribute
instance-attribute
sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelId'})
SensitivityLabel Id.
class-attribute
instance-attribute
SensitivityLabel name.
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
SensitivityLabel displayName info
class-attribute
instance-attribute
SensitivityLabel details on tooltip.
class-attribute
instance-attribute
SensitivityLabel priority.
class-attribute
instance-attribute
SensitivityLabel color.
class-attribute
instance-attribute
is_encrypted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEncrypted'})
is SensitivityLabel Encrypted.
class-attribute
instance-attribute
is_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEnabled'})
Whether SensitivityLabel is Enabled.
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 | Mapping[str, Any]]] = None, phones: Optional[List[Phone | Mapping[str, Any]]] = None)
Definition: Person
Attributes
class-attribute
instance-attribute
A unique identifier for the Person object in the directory
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
The person's display name
class-attribute
instance-attribute
given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'givenName'})
The person's given name
class-attribute
instance-attribute
The person's surname
class-attribute
instance-attribute
The person's birthday
class-attribute
instance-attribute
person_notes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'personNotes'})
Free-form notes that the current user has taken about this person
class-attribute
instance-attribute
is_favorite: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isFavorite'})
If the current user has flagged this person as a favorite
class-attribute
instance-attribute
job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})
The person's job title
class-attribute
instance-attribute
company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'companyName'})
The name of the person's company
class-attribute
instance-attribute
The person's department
class-attribute
instance-attribute
office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})
The location of the person's office
class-attribute
instance-attribute
The person's profession
class-attribute
instance-attribute
user_principal_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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.
class-attribute
instance-attribute
im_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imAddress'})
The person's VOIP SIP address
dataclass
Definition: ScoredEmailAddress
Attributes
class-attribute
instance-attribute
The email address
class-attribute
instance-attribute
relevance_score: Optional[float] = dataclass_field(default=None, kw_only=True, 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.
dataclass
Definition: Phone
Attributes
class-attribute
instance-attribute
The phone number
dataclass
User(id: str, *, 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
class-attribute
instance-attribute
A unique identifier for the user object in the directory.
class-attribute
instance-attribute
account_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountEnabled'})
true if the account is enabled; otherwise, false. This property is required when a user is created.
class-attribute
instance-attribute
business_phones: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BusinessPhones'})
A list of business phone numbers for the user
class-attribute
instance-attribute
The city in which the user is located.
class-attribute
instance-attribute
company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CompanyName'})
The name of the company in which the user works.
class-attribute
instance-attribute
country: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Country'})
The country/region in which the user is located; for example, "US" or "UK".
class-attribute
instance-attribute
department: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Department'})
The name of the department in which the user works.
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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.
class-attribute
instance-attribute
given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'GivenName'})
The given name (first name) of the user.
class-attribute
instance-attribute
job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'JobTitle'})
The user's job title.
class-attribute
instance-attribute
The SMTP/email address for the user, for example, "jeff@contoso.onmicrosoft.com". Read-Only.
class-attribute
instance-attribute
mail_nickname: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MailNickname'})
The mail alias for the user. This property must be specified when a user is created.
class-attribute
instance-attribute
mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})
The primary cellular telephone number for the user.
class-attribute
instance-attribute
office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OfficeLocation'})
The office location in the user's place of business.
class-attribute
instance-attribute
postal_code: Optional[str] = dataclass_field(default=None, kw_only=True, 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.
class-attribute
instance-attribute
surname: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Surname'})
The user's surname (family name or last name).
class-attribute
instance-attribute
telephone_number: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TelephoneNumber'})
The primary cellular telephone number for the user.
class-attribute
instance-attribute
user_principal_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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.
dataclass
Office365usersClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
update_my_profile(input: GraphUserUpdateable | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Update my profile
Updates the profile of the current user
Swagger operation ID: UpdateMyProfile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GraphUserUpdateable | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_my_photo(input: bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Update my profile photo
Updates the profile photo of the current user. The size of the photo must be less than 4 MB.
Swagger operation ID: UpdateMyPhoto.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_my_trending_documents(*, filter: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get my trending documents
Retrieves the trending documents for the signed in user
Returns a single-page Azure Core async collection.
Swagger operation ID: MyTrendingDocuments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filter
|
Optional[str]
|
An OData filter to filter the resources selected. Filter selected resources on ResourceVisualization/Type or ResourceVisualization/containerType. |
None
|
extract_sensitivity_label
|
Optional[bool]
|
Select if you want to extract Sensitivity label ( false, true). |
None
|
fetch_sensitivity_label_metadata
|
Optional[bool]
|
A boolean whether to fetch sensitivity label Metadata for associated LabelId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_relevant_people(user_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get relevant people
Get relevant people.
Returns a single-page Azure Core async collection.
Swagger operation ID: RelevantPeople.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
str
|
User principal name or id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
user_photo_metadata(user_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get user photo metadata
Get user photo metadata.
Swagger operation ID: UserPhotoMetadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_id
|
str
|
User principal name or id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_trending_documents(id: str, *, filter: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get trending documents
Retrieves the trending documents for a user
Returns a single-page Azure Core async collection.
Swagger operation ID: TrendingDocuments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
User principal name or id. |
required |
filter
|
Optional[str]
|
An OData filter to filter the resources selected. Filter selected resources on ResourceVisualization/Type or ResourceVisualization/containerType. |
None
|
extract_sensitivity_label
|
Optional[bool]
|
Select if you want to extract Sensitivity label ( false, true). |
None
|
fetch_sensitivity_label_metadata
|
Optional[bool]
|
A boolean whether to fetch sensitivity label Metadata for associated LabelId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
http_request(input: bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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/
Swagger operation ID: HttpRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_direct_reports(id: str, *, select: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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
Returns a single-page Azure Core async collection.
Swagger operation ID: DirectReports_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
User principal name or id. |
required |
select
|
Optional[str]
|
Comma separated list of fields to select. Example: surname, department, jobTitle. |
None
|
top
|
Optional[int]
|
Limit on the number of results to return. By default returns all entries. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
manager(id: str, *, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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
Swagger operation ID: Manager_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
User principal name or id. |
required |
select
|
Optional[str]
|
Comma separated list of fields to select. Example: surname, department, jobTitle. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
my_profile(*, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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
Swagger operation ID: MyProfile_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
select
|
Optional[str]
|
Comma separated list of fields to select. Example: surname, department, jobTitle. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_search_user(*, search_term: Optional[str] = None, top: Optional[int] = None, is_search_term_required: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Search for users
Retrieves the user profiles that match the search term.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: SearchUserV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
search_term
|
Optional[str]
|
Search string (applies to: display name, given name, surname, mail, mail nickname and user principal name). |
None
|
top
|
Optional[int]
|
Limit on the number of results to return. Minimum value is 1. Default value is 1000. |
None
|
is_search_term_required
|
Optional[bool]
|
If set to 'Yes' then no user profiles will be returned when the search term is empty. If set to 'No' then no filtering will be applied when the search term is empty. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
user_photo(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes
Get user photo
Retrieves the photo of the specified user if they have one
Swagger operation ID: UserPhoto_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
User principal name or id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
bytes |
bytes
|
The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
user_profile(id: str, *, select: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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
Swagger operation ID: UserProfile_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
User principal name or id. |
required |
select
|
Optional[str]
|
Comma separated list of fields to select. Example: surname, department, jobTitle. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |