office365-rest-python-client API reference

400 public APIs from office365-rest-python-client (vgrem/office365-rest-python-client) — 56 classes, 2 functions, 342 methods. Signatures extracted by static analysis of the actual source.

Repository: vgrem/office365-rest-python-client

Kind	Count
Classes	56
Functions	2
Methods	342

API list

classgenerator.builders.type.TypeBuilder

Type builder

funcoffice365.azure_env.get_graph_authority(env:AzureEnvironment) -> str

Get the Graph API endpoint for the specified environment.

funcoffice365.azure_env.get_login_authority(env:AzureEnvironment) -> str

Get the login endpoint for the specified environment.

classoffice365.booking.appointment.BookingAppointment

Represents a business in Microsoft Bookings.

classoffice365.booking.business.business.BookingBusiness

Represents a business in Microsoft Bookings.

methodoffice365.booking.business.business.BookingBusiness.address() -> PhysicalAddress

The street address of the business.

classoffice365.booking.staff.member_base.BookingStaffMemberBase

Base type of bookingStaffMember.

classoffice365.booking.work_time_slot.BookingWorkTimeSlot

Defines the start and end times for work.

classoffice365.communications.callrecords.endpoint.Endpoint

Represents an endpoint in a call.

methodoffice365.communications.callrecords.segment.Segment.callee() -> Endpoint

Endpoint that answered this segment.

methodoffice365.communications.callrecords.segment.Segment.caller() -> Endpoint

Endpoint that initiated this segment.

methodoffice365.communications.callrecords.session.Session.callee() -> Endpoint

Gets the callee property

methodoffice365.communications.callrecords.session.Session.caller() -> Endpoint

Gets the caller property

methodoffice365.communications.callrecords.session.Session.end_date_time() -> datetime

Gets the endDateTime property

methodoffice365.communications.callrecords.session.Session.is_test() -> Optional[bool]

Gets the isTest property

methodoffice365.communications.callrecords.session.Session.modalities() -> ClientValueCollection[Modality]

Gets the modalities property

methodoffice365.communications.callrecords.session.Session.start_date_time() -> datetime

Gets the startDateTime property

methodoffice365.communications.calls.call.Call.call_chain_id() -> Optional[str]

Gets the callChainId property

methodoffice365.communications.calls.call.Call.call_options() -> CallOptions

Gets the callOptions property

methodoffice365.communications.calls.call.Call.chat_info() -> ChatInfo

Gets the chatInfo property

methodoffice365.communications.calls.call.Call.direction() -> CallDirection

Gets the direction property

methodoffice365.communications.calls.call.Call.meeting_info() -> MeetingInfo

Gets the meetingInfo property

methodoffice365.communications.calls.call.Call.my_participant_id() -> Optional[str]

Gets the myParticipantId property

methodoffice365.communications.calls.call.Call.operations()

CommsOperation collection

methodoffice365.communications.calls.call.Call.participants()

Participant collection

methodoffice365.communications.calls.call.Call.result_info() -> ResultInfo

Gets the resultInfo property

methodoffice365.communications.calls.call.Call.source() -> ParticipantInfo

Gets the source property

methodoffice365.communications.calls.call.Call.state() -> CallState

Gets the state property

methodoffice365.communications.calls.call.Call.subject() -> Optional[str]

Gets the subject property

methodoffice365.communications.calls.call.Call.targets() -> ClientValueCollection[InvitationParticipantInfo]

Gets the targets property

methodoffice365.communications.calls.call.Call.tenant_id() -> Optional[str]

Gets the tenantId property

classoffice365.communications.calls.participant.Participant

Represents a participant in a call.

methodoffice365.communications.calls.participant.Participant.info() -> ParticipantInfo

Information about the participant.

classoffice365.communications.calls.route.CallRoute

Represents the call route type.

classoffice365.communications.onlinemeetings.base.OnlineMeetingBase

Represents a base online meeting.

classoffice365.communications.onlinemeetings.participants.MeetingParticipants

Participants in a meeting.

classoffice365.communications.onlinemeetings.provider_type.OnlineMeetingProviderType

Specifies the type of a principal.

classoffice365.communications.virtualevents.root.VirtualEventsRoot

The container for virtual event APIs.

methodoffice365.communications.virtualevents.root.VirtualEventsRoot.townhalls() -> EntityCollection[VirtualEventTownhall]

A collection of town halls.

methodoffice365.communications.virtualevents.root.VirtualEventsRoot.webinars() -> EntityCollection[VirtualEventWebinar]

A collection of webinars.

classoffice365.communications.virtualevents.session.VirtualEventSession

Represents a session in a virtualEvent.

classoffice365.copilot.root.CopilotRoot

A container for Microsoft 365 Copilot admin controls.

classoffice365.delta_path.DeltaPath

Delta path

classoffice365.directory.applications.app_ids.MsAppIds

Enum for commonly used Microsoft application IDs.

classoffice365.directory.applications.application.Application

Represents an application.

methodoffice365.directory.applications.application.Application.add_ins() -> ClientValueCollection[AddIn]

Gets the addIns property

method

office365.directory.applications.application.Application.add_password(display_name:str) -> ClientResult[PasswordCredential]

Adds a strong password to an application.

methodoffice365.directory.applications.application.Application.created_by_app_id() -> Optional[str]

Gets the createdByAppId property

methodoffice365.directory.applications.application.Application.created_date_time() -> datetime

Gets the createdDateTime property

methodoffice365.directory.applications.application.Application.description() -> Optional[str]

Gets the description property

methodoffice365.directory.applications.application.Application.display_name() -> Optional[str]

The display name for the application.

methodoffice365.directory.applications.application.Application.info() -> InformationalUrl

Gets the info property

methodoffice365.directory.applications.application.Application.is_disabled() -> Optional[bool]

Gets the isDisabled property

methodoffice365.directory.applications.application.Application.logo() -> bytes | None

Gets the logo property

methodoffice365.directory.applications.application.Application.notes() -> Optional[str]

Gets the notes property

methodoffice365.directory.applications.application.Application.publisher_domain() -> Optional[str]

Gets the publisherDomain property

methodoffice365.directory.applications.application.Application.remove_certificate(thumbprint:str) -> Self

Remove a certificate from an application.

methodoffice365.directory.applications.application.Application.remove_key(key_id:str, proof:str) -> Self

Remove a key credential from an application.

methodoffice365.directory.applications.application.Application.remove_password(key_id:str) -> Self

Remove a password from an application.

methodoffice365.directory.applications.application.Application.saml_metadata_url() -> Optional[str]

Gets the samlMetadataUrl property

methodoffice365.directory.applications.application.Application.set_verified_publisher(verified_publisher_id:str) -> Self

Set the verifiedPublisher on an application.

methodoffice365.directory.applications.application.Application.sign_in_audience() -> Optional[str]

Gets the signInAudience property

methodoffice365.directory.applications.application.Application.synchronization() -> Synchronization

Gets the synchronization property

methodoffice365.directory.applications.application.Application.tags() -> StringCollection

Gets the tags property

methodoffice365.directory.applications.application.Application.unique_name() -> Optional[str]

Gets the uniqueName property

methodoffice365.directory.applications.application.Application.verified_publisher() -> VerifiedPublisher

Gets the verifiedPublisher property

methodoffice365.directory.applications.application.Application.web() -> WebApplication

Gets the web property

classoffice365.directory.applications.collection.ApplicationCollection

DirectoryObject's collection

methodoffice365.directory.applications.collection.ApplicationCollection.add(display_name:str, **kwargs:Any) -> Application

Create a new application object.

classoffice365.directory.applications.spa.SpaApplication

Specifies settings for a single-page application.

classoffice365.directory.applications.web.WebApplication

Specifies settings for a web application.

classoffice365.directory.audit.log_root.AuditLogRoot

Contains different types of audit logs.

classoffice365.directory.authentication.methods.password.PasswordAuthenticationMethod

A representation of a user's password.

classoffice365.directory.certificates.authority.CertificateAuthority

Represents a certificate authority.

classoffice365.directory.datapolicy.operation.DataPolicyOperation

Represents a submitted data policy operation.

classoffice365.directory.directory.Directory

Represents a deleted item in the directory.

methodoffice365.directory.directory.Directory.deleted_groups()

Recently deleted groups

methodoffice365.directory.directory.Directory.deleted_items(entity_type=None) -> DirectoryObjectCollection

Recently deleted items.

methodoffice365.directory.directory.Directory.deleted_teams()

Recently deleted groups

methodoffice365.directory.directory.Directory.deleted_users()

Recently deleted users

classoffice365.directory.domains.domain.Domain

Represents a domain associated with the tenant.

methodoffice365.directory.domains.domain.Domain.supported_services() -> StringCollection

The capabilities assigned to the domain.

methodoffice365.directory.domains.domain.Domain.verify() -> 'Domain'

Validates the ownership of the domain.

classoffice365.directory.domains.verified.VerifiedDomain

Specifies a domain for a tenant.

methodoffice365.directory.featuretype.FeatureType.entity_type_name()

Get the entity type name.

classoffice365.directory.groups.collection.GroupCollection

Group's collection

methodoffice365.directory.groups.collection.GroupCollection.add(group_properties:GroupProfile) -> Group

Create a Group resource.

method

office365.directory.groups.collection.GroupCollection.create_m365(name:str, description:str | None=None, owners:list[str] | None=None, members:list[str] | None=None) -> Group

Creates a Microsoft 365 group.

methodoffice365.directory.groups.collection.GroupCollection.create_with_team(group_name:str) -> Group

Provision a new group along with a team.

methodoffice365.directory.groups.collection.GroupCollection.get_by_name(name:str) -> Group

Retrieves group by displayName

methodoffice365.directory.groups.group.Group.accepted_senders() -> EntityCollection[DirectoryObject]

Gets the acceptedSenders property

methodoffice365.directory.groups.group.Group.add_team() -> Team

Create a new team under a group.

methodoffice365.directory.groups.group.Group.allow_external_senders() -> Optional[bool]

Gets the allowExternalSenders property

methodoffice365.directory.groups.group.Group.calendar() -> Calendar

Gets the calendar property

methodoffice365.directory.groups.group.Group.calendar_view() -> EntityCollection[Event]

Gets the calendarView property

methodoffice365.directory.groups.group.Group.conversations() -> EntityCollection[Conversation]

The group's conversations.

methodoffice365.directory.groups.group.Group.created_date_time() -> datetime

Gets the createdDateTime property

methodoffice365.directory.groups.group.Group.created_datetime() -> datetime

Timestamp of when the group was created.

methodoffice365.directory.groups.group.Group.created_on_behalf_of() -> DirectoryObject

Gets the createdOnBehalfOf property

methodoffice365.directory.groups.group.Group.description() -> Optional[str]

Gets the description property

methodoffice365.directory.groups.group.Group.display_name() -> Optional[str]

The display name for the group.

methodoffice365.directory.groups.group.Group.drive() -> Drive

Gets the drive property

methodoffice365.directory.groups.group.Group.drives() -> EntityCollection[Drive]

The group's drives.

methodoffice365.directory.groups.group.Group.events() -> EventCollection

Get an event collection or an event.

methodoffice365.directory.groups.group.Group.expiration_date_time() -> datetime

Gets the expirationDateTime property

methodoffice365.directory.groups.group.Group.group_types() -> StringCollection

Specifies the group type and its membership.

methodoffice365.directory.groups.group.Group.hide_from_address_lists() -> Optional[bool]

Gets the hideFromAddressLists property

methodoffice365.directory.groups.group.Group.info_catalogs() -> StringCollection

Gets the infoCatalogs property

methodoffice365.directory.groups.group.Group.is_archived() -> Optional[bool]

Gets the isArchived property

methodoffice365.directory.groups.group.Group.is_management_restricted() -> Optional[bool]

Gets the isManagementRestricted property

methodoffice365.directory.groups.group.Group.is_subscribed_by_mail() -> Optional[bool]

Gets the isSubscribedByMail property

methodoffice365.directory.groups.group.Group.mail_enabled() -> Optional[bool]

Specifies whether the group is mail-enabled.

methodoffice365.directory.groups.group.Group.member_of() -> EntityCollection[DirectoryObject]

Gets the memberOf property

methodoffice365.directory.groups.group.Group.membership_rule() -> Optional[str]

Gets the membershipRule property

methodoffice365.directory.groups.group.Group.on_premises_net_bios_name() -> Optional[str]

Gets the onPremisesNetBiosName property

methodoffice365.directory.groups.group.Group.on_premises_sync_enabled() -> Optional[bool]

Gets the onPremisesSyncEnabled property

methodoffice365.directory.groups.group.Group.owners() -> DirectoryObjectCollection

The owners of the group.

methodoffice365.directory.groups.group.Group.photo() -> ProfilePhoto

The group's profile photo

methodoffice365.directory.groups.group.Group.photos() -> EntityCollection[ProfilePhoto]

Gets the photos property

methodoffice365.directory.groups.group.Group.preferred_data_location() -> Optional[str]

Gets the preferredDataLocation property

methodoffice365.directory.groups.group.Group.preferred_language() -> Optional[str]

Gets the preferredLanguage property

methodoffice365.directory.groups.group.Group.proxy_addresses() -> StringCollection

Gets the proxyAddresses property

methodoffice365.directory.groups.group.Group.renew() -> Self

Renews a group's expiration.

methodoffice365.directory.groups.group.Group.renewed_date_time() -> datetime

Gets the renewedDateTime property

methodoffice365.directory.groups.group.Group.security_enabled() -> Optional[bool]

Gets the securityEnabled property

methodoffice365.directory.groups.group.Group.security_identifier() -> Optional[str]

Gets the securityIdentifier property

methodoffice365.directory.groups.group.Group.settings() -> EntityCollection[GroupSetting]

Gets the settings property

methodoffice365.directory.groups.group.Group.team() -> Team

The team associated with this group.

methodoffice365.directory.groups.group.Group.theme() -> Optional[str]

Gets the theme property

methodoffice365.directory.groups.group.Group.threads() -> EntityCollection[ConversationThread]

The group's conversation threads

methodoffice365.directory.groups.group.Group.transitive_members() -> DirectoryObjectCollection

Get a list of the group's members.

methodoffice365.directory.groups.group.Group.unique_name() -> Optional[str]

Gets the uniqueName property

methodoffice365.directory.groups.group.Group.unseen_count() -> Optional[int]

Gets the unseenCount property

methodoffice365.directory.groups.group.Group.visibility() -> Optional[str]

Gets the visibility property

methodoffice365.directory.groups.group.Group.welcome_message_enabled() -> Optional[bool]

Gets the welcomeMessageEnabled property

methodoffice365.directory.identities.provider.IdentityProvider.client_id() -> Optional[str]

The client ID for the application.

methodoffice365.directory.identities.provider.IdentityProvider.client_secret() -> Optional[str]

The client secret for the application.

methodoffice365.directory.identitygovernance.accessreview.instance.AccessReviewInstance.end_date_time() -> datetime

Gets the endDateTime property

methodoffice365.directory.identitygovernance.accessreview.instance.AccessReviewInstance.scope() -> AccessReviewScope

Gets the scope property

methodoffice365.directory.identitygovernance.accessreview.instance.AccessReviewInstance.status() -> Optional[str]

Gets the status property

classoffice365.directory.identitygovernance.accessreview.stages.AccessReviewStageCollection

AccessReviewStage collection

methodoffice365.directory.identitygovernance.appconsent.approval_stage.ApprovalStage.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.identitygovernance.appconsent.approval_stage.ApprovalStage.review_result() -> Optional[str]

Gets the reviewResult property

methodoffice365.directory.identitygovernance.appconsent.approval_stage.ApprovalStage.reviewed_by() -> Identity

Gets the reviewedBy property

methodoffice365.directory.identitygovernance.appconsent.approval_stage.ApprovalStage.status() -> Optional[str]

Gets the status property

classoffice365.directory.identitygovernance.appconsent.request_collection.AppConsentRequestCollection

AppConsentRequest's collection

methodoffice365.directory.identitygovernance.run.Run.activated_on_scope() -> ActivationScope

Gets the activatedOnScope property

methodoffice365.directory.identitygovernance.run.Run.completed_date_time() -> datetime

Gets the completedDateTime property

methodoffice365.directory.identitygovernance.run.Run.failed_tasks_count() -> Optional[int]

Gets the failedTasksCount property

methodoffice365.directory.identitygovernance.run.Run.failed_users_count() -> Optional[int]

Gets the failedUsersCount property

methodoffice365.directory.identitygovernance.run.Run.last_updated_date_time() -> datetime

Gets the lastUpdatedDateTime property

methodoffice365.directory.identitygovernance.run.Run.processing_status() -> LifecycleWorkflowProcessingStatus

Gets the processingStatus property

methodoffice365.directory.identitygovernance.run.Run.reprocessed_runs() -> EntityCollection[Run]

Gets the reprocessedRuns property

methodoffice365.directory.identitygovernance.run.Run.scheduled_date_time() -> datetime

Gets the scheduledDateTime property

methodoffice365.directory.identitygovernance.run.Run.started_date_time() -> datetime

Gets the startedDateTime property

methodoffice365.directory.identitygovernance.run.Run.successful_users_count() -> Optional[int]

Gets the successfulUsersCount property

methodoffice365.directory.identitygovernance.run.Run.total_tasks_count() -> Optional[int]

Gets the totalTasksCount property

methodoffice365.directory.identitygovernance.run.Run.total_users_count() -> Optional[int]

Gets the totalUsersCount property

methodoffice365.directory.identitygovernance.task.Task.arguments() -> ClientValueCollection[KeyValuePair]

Gets the arguments property

methodoffice365.directory.identitygovernance.task.Task.category() -> LifecycleTaskCategory

Gets the category property

methodoffice365.directory.identitygovernance.task.Task.continue_on_error() -> Optional[bool]

Gets the continueOnError property

methodoffice365.directory.identitygovernance.task.Task.description() -> Optional[str]

Gets the description property

methodoffice365.directory.identitygovernance.task.Task.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.identitygovernance.task.Task.execution_sequence() -> Optional[int]

Gets the executionSequence property

methodoffice365.directory.identitygovernance.task.Task.is_enabled() -> Optional[bool]

Gets the isEnabled property

methodoffice365.directory.identitygovernance.task.Task.task_definition_id() -> Optional[str]

Gets the taskDefinitionId property

classoffice365.directory.identitygovernance.userconsent.request_collection.UserConsentRequestCollection

AppConsentRequest's collection

methodoffice365.directory.identitygovernance.workflow.Workflow.deleted_date_time() -> Optional[datetime]

Gets the deletedDateTime property

methodoffice365.directory.identitygovernance.workflow.Workflow.id_() -> Optional[str]

Gets the id property

methodoffice365.directory.identitygovernance.workflow.Workflow.runs() -> EntityCollection[Run]

Gets the runs property

methodoffice365.directory.identitygovernance.workflow.Workflow.task_reports() -> EntityCollection[TaskReport]

Gets the taskReports property

methodoffice365.directory.identitygovernance.workflow.Workflow.version() -> Optional[int]

Gets the version property

methodoffice365.directory.identitygovernance.workflow.Workflow.versions() -> EntityCollection[WorkflowVersion]

Gets the versions property

methodoffice365.directory.identitygovernance.workflow_version.WorkflowVersion.version_number() -> Optional[int]

Gets the versionNumber property

classoffice365.directory.internal.paths.me.MePath

SignedIn user resource path

classoffice365.directory.invitations.collection.InvitationCollection

Invitation's collection

classoffice365.directory.licenses.assigned_license.AssignedLicense

Represents a license assigned to a user.

methodoffice365.directory.licenses.details.LicenseDetails.sku_part_number() -> Optional[str]

Unique SKU display name.

classoffice365.directory.objects.collection.DirectoryObjectCollection

DirectoryObject's collection

methodoffice365.directory.objects.collection.DirectoryObjectCollection.add(directory_object:DirectoryObject) -> Self

Adds directory objects to the collection.

method

office365.directory.objects.collection.DirectoryObjectCollection.remove(directory_object:Union[DirectoryObject, str]) -> Self

Removes directory object from the collection.

classoffice365.directory.objects.object.DirectoryObject

Represents an Azure Active Directory object.

methodoffice365.directory.objects.object.DirectoryObject.deleted_date_time() -> datetime

Gets the deletedDateTime property

classoffice365.directory.permissions.email_identity.EmailIdentity

Represents the email identity of a user.

classoffice365.directory.permissions.grants.oauth2_collection.OAuth2PermissionGrantCollection

DirectoryObject's collection

classoffice365.directory.protection.riskyusers.collection.RiskyUserCollection

RiskyUser's collection

classoffice365.directory.protection.riskyusers.risky_user.RiskyUser

Represents Azure AD users who are at risk.

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.is_deleted() -> Optional[bool]

Gets the isDeleted property

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.is_processing() -> Optional[bool]

Gets the isProcessing property

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.risk_detail() -> RiskDetail

Gets the riskDetail property

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.risk_level() -> RiskLevel

Gets the riskLevel property

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.risk_state() -> RiskState

Gets the riskState property

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.user_display_name() -> Optional[str]

Gets the userDisplayName property

methodoffice365.directory.protection.riskyusers.risky_user.RiskyUser.user_principal_name() -> Optional[str]

Risky user principal name.

classoffice365.directory.rolemanagement.roles.collection.DirectoryRoleCollection

User's collection

methodoffice365.directory.rolemanagement.roles.collection.DirectoryRoleCollection.assign(role_name:str) -> Self

Activate a directory role by display name.

classoffice365.directory.rolemanagement.roles.role.DirectoryRole

Represents an Azure AD directory role.

classoffice365.directory.rolemanagement.templates.collection.DirectoryRoleTemplateCollection

User's collection

classoffice365.directory.rolemanagement.templates.template.DirectoryRoleTemplate

Represents a directory role template.

methodoffice365.directory.security.alerts.alert.Alert.alert_web_url() -> Optional[str]

Gets the alertWebUrl property

methodoffice365.directory.security.alerts.alert.Alert.assigned_to() -> Optional[str]

Gets the assignedTo property

methodoffice365.directory.security.alerts.alert.Alert.categories() -> StringCollection

Gets the categories property

methodoffice365.directory.security.alerts.alert.Alert.category() -> Optional[str]

Gets the category property

methodoffice365.directory.security.alerts.alert.Alert.classification() -> AlertClassification

Gets the classification property

methodoffice365.directory.security.alerts.alert.Alert.comments() -> ClientValueCollection[AlertComment]

Gets the comments property

methodoffice365.directory.security.alerts.alert.Alert.created_date_time() -> Optional[datetime]

Gets the createdDateTime property

methodoffice365.directory.security.alerts.alert.Alert.description() -> Optional[str]

Gets the description property

methodoffice365.directory.security.alerts.alert.Alert.detection_source() -> DetectionSource

Gets the detectionSource property

methodoffice365.directory.security.alerts.alert.Alert.detector_id() -> Optional[str]

Gets the detectorId property

methodoffice365.directory.security.alerts.alert.Alert.determination() -> AlertDetermination

Gets the determination property

methodoffice365.directory.security.alerts.alert.Alert.incident_id() -> Optional[str]

Gets the incidentId property

methodoffice365.directory.security.alerts.alert.Alert.incident_web_url() -> Optional[str]

Gets the incidentWebUrl property

methodoffice365.directory.security.alerts.alert.Alert.last_update_date_time() -> Optional[datetime]

Gets the lastUpdateDateTime property

methodoffice365.directory.security.alerts.alert.Alert.mitre_techniques() -> StringCollection

Gets the mitreTechniques property

methodoffice365.directory.security.alerts.alert.Alert.product_name() -> Optional[str]

Gets the productName property

methodoffice365.directory.security.alerts.alert.Alert.provider_alert_id() -> Optional[str]

Gets the providerAlertId property

methodoffice365.directory.security.alerts.alert.Alert.recommended_actions() -> Optional[str]

Gets the recommendedActions property

methodoffice365.directory.security.alerts.alert.Alert.resolved_date_time() -> Optional[datetime]

Gets the resolvedDateTime property

methodoffice365.directory.security.alerts.alert.Alert.severity() -> AlertSeverity

Gets the severity property

methodoffice365.directory.security.alerts.alert.Alert.status() -> AlertStatus

Gets the status property

methodoffice365.directory.security.alerts.alert.Alert.system_tags() -> StringCollection

Gets the systemTags property

methodoffice365.directory.security.alerts.alert.Alert.tenant_id() -> Optional[str]

Gets the tenantId property

methodoffice365.directory.security.alerts.alert.Alert.threat_display_name() -> Optional[str]

Gets the threatDisplayName property

methodoffice365.directory.security.alerts.alert.Alert.threat_family_name() -> Optional[str]

Gets the threatFamilyName property

methodoffice365.directory.security.alerts.alert.Alert.title() -> Optional[str]

Gets the title property

classoffice365.directory.security.alerts.collection.AlertCollection

Service Principal's collection

classoffice365.directory.security.alerts.history_state.AlertHistoryState

Stores changes made to alerts.

methodoffice365.directory.security.article.Article.created_date_time() -> datetime

Gets the createdDateTime property

methodoffice365.directory.security.article.Article.image_url() -> Optional[str]

Gets the imageUrl property

methodoffice365.directory.security.article.Article.indicators() -> EntityCollection[ArticleIndicator]

Gets the indicators property

methodoffice365.directory.security.article.Article.is_featured() -> Optional[bool]

Gets the isFeatured property

methodoffice365.directory.security.article.Article.last_updated_date_time() -> datetime

Gets the lastUpdatedDateTime property

methodoffice365.directory.security.article.Article.tags() -> StringCollection

Gets the tags property

methodoffice365.directory.security.article.Article.title() -> Optional[str]

Gets the title property

methodoffice365.directory.security.case.Case.created_date_time() -> Optional[datetime]

Gets the createdDateTime property

methodoffice365.directory.security.case.Case.description() -> Optional[str]

Gets the description property

methodoffice365.directory.security.case.Case.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.security.case.Case.last_modified_by() -> IdentitySet

Gets the lastModifiedBy property

methodoffice365.directory.security.case.Case.last_modified_date_time() -> Optional[datetime]

Gets the lastModifiedDateTime property

methodoffice365.directory.security.case.Case.status() -> CaseStatus

Gets the status property

methodoffice365.directory.security.data_set.DataSet.created_by() -> IdentitySet

Gets the createdBy property

methodoffice365.directory.security.data_set.DataSet.created_date_time() -> Optional[datetime]

Gets the createdDateTime property

methodoffice365.directory.security.data_set.DataSet.description() -> Optional[str]

Gets the description property

methodoffice365.directory.security.data_set.DataSet.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.security.host.Host.child_host_pairs() -> EntityCollection[HostPair]

Gets the childHostPairs property

methodoffice365.directory.security.host.Host.components() -> EntityCollection[HostComponent]

Gets the components property

methodoffice365.directory.security.host.Host.cookies() -> EntityCollection[HostCookie]

Gets the cookies property

methodoffice365.directory.security.host.Host.first_seen_date_time() -> datetime

Gets the firstSeenDateTime property

methodoffice365.directory.security.host.Host.host_pairs() -> EntityCollection[HostPair]

Gets the hostPairs property

methodoffice365.directory.security.host.Host.last_seen_date_time() -> datetime

Gets the lastSeenDateTime property

methodoffice365.directory.security.host.Host.parent_host_pairs() -> EntityCollection[HostPair]

Gets the parentHostPairs property

methodoffice365.directory.security.host.Host.passive_dns() -> EntityCollection[PassiveDnsRecord]

Gets the passiveDns property

methodoffice365.directory.security.host.Host.passive_dns_reverse() -> EntityCollection[PassiveDnsRecord]

Gets the passiveDnsReverse property

methodoffice365.directory.security.host.Host.ports() -> EntityCollection[HostPort]

Gets the ports property

methodoffice365.directory.security.host.Host.reputation() -> HostReputation

Gets the reputation property

methodoffice365.directory.security.host.Host.ssl_certificates() -> EntityCollection[HostSslCertificate]

Gets the sslCertificates property

methodoffice365.directory.security.host.Host.subdomains() -> EntityCollection[Subdomain]

Gets the subdomains property

methodoffice365.directory.security.host.Host.trackers() -> EntityCollection[HostTracker]

Gets the trackers property

methodoffice365.directory.security.host.Host.whois() -> WhoisRecord

Gets the whois property

methodoffice365.directory.security.hostname.Hostname.registrant() -> Optional[str]

Gets the registrant property

methodoffice365.directory.security.hostname.Hostname.registrar() -> Optional[str]

Gets the registrar property

methodoffice365.directory.security.indicator.Indicator.artifact() -> Artifact

Gets the artifact property

methodoffice365.directory.security.ip_address.IpAddress.country_or_region() -> Optional[str]

Gets the countryOrRegion property

methodoffice365.directory.security.ip_address.IpAddress.hosting_provider() -> Optional[str]

Gets the hostingProvider property

methodoffice365.directory.security.ip_address.IpAddress.netblock() -> Optional[str]

Gets the netblock property

methodoffice365.directory.security.search.Search.content_query() -> Optional[str]

Gets the contentQuery property

methodoffice365.directory.security.search.Search.created_by() -> IdentitySet

Gets the createdBy property

methodoffice365.directory.security.search.Search.created_date_time() -> Optional[datetime]

Gets the createdDateTime property

methodoffice365.directory.security.search.Search.description() -> Optional[str]

Gets the description property

methodoffice365.directory.security.search.Search.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.security.search.Search.last_modified_by() -> IdentitySet

Gets the lastModifiedBy property

methodoffice365.directory.security.search.Search.last_modified_date_time() -> Optional[datetime]

Gets the lastModifiedDateTime property

methodoffice365.directory.security.search.data_source.DataSource.created_by() -> IdentitySet

Gets the createdBy property

methodoffice365.directory.security.search.data_source.DataSource.created_date_time() -> Optional[datetime]

Gets the createdDateTime property

methodoffice365.directory.security.search.data_source.DataSource.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.security.search.data_source.DataSource.hold_status() -> DataSourceHoldStatus

Gets the holdStatus property

methodoffice365.directory.security.tag.Tag.created_by() -> IdentitySet

Gets the createdBy property

methodoffice365.directory.security.tag.Tag.description() -> Optional[str]

Gets the description property

methodoffice365.directory.security.tag.Tag.display_name() -> Optional[str]

Gets the displayName property

methodoffice365.directory.security.tag.Tag.last_modified_date_time() -> Optional[datetime]

Gets the lastModifiedDateTime property

methodoffice365.directory.security.vulnerability.Vulnerability.articles() -> EntityCollection[Article]

Gets the articles property

methodoffice365.directory.security.vulnerability.Vulnerability.components() -> EntityCollection[VulnerabilityComponent]

Gets the components property

methodoffice365.directory.security.vulnerability.Vulnerability.created_date_time() -> datetime

Gets the createdDateTime property

methodoffice365.directory.security.vulnerability.Vulnerability.exploits_available() -> Optional[bool]

Gets the exploitsAvailable property

methodoffice365.directory.security.vulnerability.Vulnerability.has_chatter() -> Optional[bool]

Gets the hasChatter property

methodoffice365.directory.security.vulnerability.Vulnerability.priority_score() -> Optional[int]

Gets the priorityScore property

methodoffice365.directory.security.vulnerability.Vulnerability.published_date_time() -> datetime

Gets the publishedDateTime property

classoffice365.directory.serviceprincipals.collection.ServicePrincipalCollection

Service Principal's collection

methodoffice365.directory.serviceprincipals.collection.ServicePrincipalCollection.add(app_id:str) -> ServicePrincipal

Create a new servicePrincipal object.

classoffice365.directory.users.activities.collection.UserActivityCollection

User activities collection

classoffice365.directory.users.collection.UserCollection

User's collection

methodoffice365.directory.users.collection.UserCollection.add(user_properties:UserProfile) -> User

Create a new user.

classoffice365.directory.users.settings.UserSettings

The current user settings for content discovery.

classoffice365.directory.users.user.User

Represents an Azure AD user account.

methodoffice365.directory.users.user.User.about_me() -> Optional[str]

Gets the aboutMe property

methodoffice365.directory.users.user.User.activities() -> UserActivityCollection

The user's activities across devices.

methodoffice365.directory.users.user.User.age_group() -> str | None

Gets the age group of the user

method

office365.directory.users.user.User.assign_license(add_licenses:list[str] | list[AssignedLicense], remove_licenses:list[str] | None=None) -> Self

Add or remove licenses on the user.

methodoffice365.directory.users.user.User.assign_manager(user:str | User | OrgContact) -> DirectoryObject

Assign a user's manager.

methodoffice365.directory.users.user.User.authorization_info() -> AuthorizationInfo

Gets the authorizationInfo property

methodoffice365.directory.users.user.User.birthday() -> datetime

Gets the birthday property

methodoffice365.directory.users.user.User.calendar() -> Calendar

The user's primary calendar.

methodoffice365.directory.users.user.User.calendar_groups() -> EntityCollection[CalendarGroup]

The user's calendar groups.

methodoffice365.directory.users.user.User.calendar_view() -> EntityCollection[Event]

Gets the calendarView property

methodoffice365.directory.users.user.User.calendars() -> EntityCollection[Calendar]

The user's calendar groups.

methodoffice365.directory.users.user.User.change_password(current_password:str, new_password:str) -> Self

Enable the user to update their password.

methodoffice365.directory.users.user.User.chats() -> ChatCollection

The user's chats.

methodoffice365.directory.users.user.User.city() -> Optional[str]

Gets the city property

methodoffice365.directory.users.user.User.company_name() -> Optional[str]

Gets the companyName property

methodoffice365.directory.users.user.User.consent_provided_for_minor() -> Optional[str]

Gets the consentProvidedForMinor property

methodoffice365.directory.users.user.User.country() -> Optional[str]

Gets the country property

methodoffice365.directory.users.user.User.created_date_time() -> datetime

Gets the createdDateTime property

methodoffice365.directory.users.user.User.created_objects() -> DirectoryObjectCollection

Directory objects created by this user.

methodoffice365.directory.users.user.User.department() -> Optional[str]

Gets the department property

methodoffice365.directory.users.user.User.direct_reports() -> DirectoryObjectCollection

Get a user's direct reports

methodoffice365.directory.users.user.User.drives() -> EntityCollection[Drive]

Gets the drives property

methodoffice365.directory.users.user.User.employee_hire_date() -> datetime

Gets the employeeHireDate property

methodoffice365.directory.users.user.User.employee_id() -> Optional[str]

Gets the employeeId property

methodoffice365.directory.users.user.User.employee_leave_date_time() -> datetime

Gets the employeeLeaveDateTime property

methodoffice365.directory.users.user.User.employee_org_data() -> EmployeeOrgData

Gets the employeeOrgData property

methodoffice365.directory.users.user.User.employee_type() -> Optional[str]

Gets the employeeType property

methodoffice365.directory.users.user.User.events() -> DeltaCollection[Event]

Get an event collection or an event.

methodoffice365.directory.users.user.User.external_user_state() -> Optional[str]

Gets the externalUserState property

methodoffice365.directory.users.user.User.fax_number() -> Optional[str]

Gets the faxNumber property

methodoffice365.directory.users.user.User.follow_site(site:str | Site) -> Self

follow a site

methodoffice365.directory.users.user.User.get_my_site() -> Site

Gets user's site

methodoffice365.directory.users.user.User.given_name() -> Optional[str]

The given name (first name) of the user.

methodoffice365.directory.users.user.User.hire_date() -> datetime

Gets the hireDate property

methodoffice365.directory.users.user.User.identity_parent_id() -> Optional[str]

Gets the identityParentId property

methodoffice365.directory.users.user.User.im_addresses() -> StringCollection

Gets the imAddresses property

methodoffice365.directory.users.user.User.is_management_restricted() -> Optional[bool]

Gets the isManagementRestricted property

methodoffice365.directory.users.user.User.is_resource_account() -> Optional[bool]

Gets the isResourceAccount property

methodoffice365.directory.users.user.User.job_title() -> Optional[str]

Gets the jobTitle property

methodoffice365.directory.users.user.User.mail_nickname() -> Optional[str]

Gets the mailNickname property

methodoffice365.directory.users.user.User.mailbox_settings() -> MailboxSettings

Get the user's mailboxSettings.

methodoffice365.directory.users.user.User.manager() -> DirectoryObject

The user or contact that is this user's manager

methodoffice365.directory.users.user.User.messages() -> MessageCollection

Get an event collection or an event.

methodoffice365.directory.users.user.User.mobile_phone() -> Optional[str]

Gets the mobilePhone property

methodoffice365.directory.users.user.User.my_site() -> Optional[str]

The URL for the user's site.

methodoffice365.directory.users.user.User.on_premises_immutable_id() -> Optional[str]

Gets the onPremisesImmutableId property

methodoffice365.directory.users.user.User.on_premises_sync_enabled() -> Optional[bool]

Gets the onPremisesSyncEnabled property

methodoffice365.directory.users.user.User.online_meetings() -> OnlineMeetingCollection

Get a user's online meetings.

methodoffice365.directory.users.user.User.owned_devices() -> DirectoryObjectCollection

Devices that are owned by the user.

methodoffice365.directory.users.user.User.password_policies() -> Optional[str]

Specifies password policies for the user.

methodoffice365.directory.users.user.User.past_projects() -> StringCollection

Gets the pastProjects property

methodoffice365.directory.users.user.User.people() -> EntityCollection[Person]

People that are relevant to the user.

methodoffice365.directory.users.user.User.photo() -> ProfilePhoto

The user's profile photo.

methodoffice365.directory.users.user.User.postal_code() -> Optional[str]

Gets the postalCode property

methodoffice365.directory.users.user.User.preferred_data_location() -> Optional[str]

Gets the preferredDataLocation property

methodoffice365.directory.users.user.User.preferred_language() -> Optional[str]

The preferred language for the user.

methodoffice365.directory.users.user.User.preferred_name() -> Optional[str]

Gets the preferredName property

methodoffice365.directory.users.user.User.presence() -> Presence

Get a user's presence information.

methodoffice365.directory.users.user.User.print_() -> UserPrint

Gets the print property

methodoffice365.directory.users.user.User.provisioned_plans() -> ClientValueCollection[ProvisionedPlan]

Gets the provisionedPlans property

methodoffice365.directory.users.user.User.remove_manager() -> Self

Remove a user's manager.

methodoffice365.directory.users.user.User.responsibilities() -> StringCollection

Gets the responsibilities property

methodoffice365.directory.users.user.User.schools() -> StringCollection

Gets the schools property

methodoffice365.directory.users.user.User.show_in_address_list() -> Optional[bool]

Gets the showInAddressList property

methodoffice365.directory.users.user.User.skills() -> StringCollection

Gets the skills property

methodoffice365.directory.users.user.User.sponsors() -> EntityCollection[DirectoryObject]

Gets the sponsors property

methodoffice365.directory.users.user.User.state() -> Optional[str]

Gets the state property

methodoffice365.directory.users.user.User.surname() -> Optional[str]

Gets the surname property

methodoffice365.directory.users.user.User.todo() -> Todo

Represents the To Do services available to a user.

methodoffice365.directory.users.user.User.unfollow_site(site:str | Site) -> Self

Unfollow a user's site or multiple sites.

methodoffice365.directory.users.user.User.user_principal_name() -> Optional[str]

The user principal name (UPN) of the user.

methodoffice365.directory.users.user.User.user_type() -> Optional[str]

Gets the userType property

classoffice365.education.classes.type.EducationClass

Represents a class within a school.

classoffice365.education.users.user.EducationUser

A user in the system.

classoffice365.entity.Entity

Base entity for Microsoft Graph objects with common CRUD operations.

methodoffice365.entity.Entity.context() -> GraphClient

Gets the GraphClient context for this entity.

methodoffice365.entity.Entity.delete_object() -> Self

Deletes the entity from Microsoft Graph.

methodoffice365.entity.Entity.entity_type_name() -> str

Gets the Microsoft Graph type name for this entity.

methodoffice365.entity.Entity.id() -> str | None

Gets the unique identifier of the entity.

methodoffice365.entity.Entity.update() -> Self

Updates the entity in Microsoft Graph.

classoffice365.entity_collection.EntityCollection

A collection container which represents a named collections of entities

methodoffice365.entity_collection.EntityCollection.add(*args:Any, **kwargs:Any) -> ClientObjectT

Creates an entity and prepares the query

methodoffice365.externalconnectors.schema.Schema.base_type() -> Optional[str]

Gets the baseType property

classoffice365.graph_client.GraphClient

Microsoft Graph API client

methodoffice365.graph_client.GraphClient.chats() -> ChatCollection

Chats container

methodoffice365.graph_client.GraphClient.communications() -> CloudCommunications

Cloud communications API endpoint

methodoffice365.graph_client.GraphClient.devices() -> DeviceCollection

Devices container

methodoffice365.graph_client.GraphClient.directory() -> Directory

Represents a deleted item in the directory

methodoffice365.graph_client.GraphClient.directory_objects() -> DirectoryObjectCollection

Directory Objects container

methodoffice365.graph_client.GraphClient.domains() -> EntityCollection[Domain]

Alias to domains

methodoffice365.graph_client.GraphClient.drives() -> 'DriveCollection'

Get one drives

methodoffice365.graph_client.GraphClient.employee_experience() -> EmployeeExperience

An alias to EmployeeExperience

methodoffice365.graph_client.GraphClient.external() -> External

A logical container for external sources.

methodoffice365.graph_client.GraphClient.group_settings() -> GroupSetting

Represents a directory roles in the directory

methodoffice365.graph_client.GraphClient.groups() -> GroupCollection

Get groups

methodoffice365.graph_client.GraphClient.identity_governance() -> IdentityGovernance

The identity governance singleton

methodoffice365.graph_client.GraphClient.identity_protection() -> IdentityProtectionRoot

Identity Protection alias

methodoffice365.graph_client.GraphClient.invitations() -> InvitationCollection

Get invitations

methodoffice365.graph_client.GraphClient.oauth2_permission_grants() -> OAuth2PermissionGrantCollection

Permission grants container

methodoffice365.graph_client.GraphClient.pending_request() -> GraphRequest

Get or create the pending request

methodoffice365.graph_client.GraphClient.places() -> EntityCollection[Place]

Gets all places in a tenant

methodoffice365.graph_client.GraphClient.revoke_delegated_permissions(client_id:str, scope:str) -> Self

Revokes a delegated permission on Microsoft Graph.

methodoffice365.graph_client.GraphClient.room_lists() -> EntityCollection[RoomList]

Gets all the room lists in a tenant

methodoffice365.graph_client.GraphClient.shares() -> SharesCollection

Shares container

methodoffice365.graph_client.GraphClient.sites() -> SitesWithRoot

Sites container

methodoffice365.graph_client.GraphClient.teams() -> TeamCollection

Teams container

About this data

These signatures were extracted from the public source of vgrem/office365-rest-python-client using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries