@microsoft/msgraph-sdk-users
Version:
Users fluent API for Microsoft Graph
467 lines • 23.4 kB
TypeScript
import { type User } from '@microsoft/msgraph-sdk/models/index.js';
import { type ActivitiesRequestBuilder } from './activities/index.js';
import { type AgreementAcceptancesRequestBuilder } from './agreementAcceptances/index.js';
import { type AppRoleAssignmentsRequestBuilder } from './appRoleAssignments/index.js';
import { type AssignLicenseRequestBuilder } from './assignLicense/index.js';
import { type AuthenticationRequestBuilder } from './authentication/index.js';
import { type CalendarRequestBuilder } from './calendar/index.js';
import { type CalendarGroupsRequestBuilder } from './calendarGroups/index.js';
import { type CalendarsRequestBuilder } from './calendars/index.js';
import { type CalendarViewRequestBuilder } from './calendarView/index.js';
import { type ChangePasswordRequestBuilder } from './changePassword/index.js';
import { type ChatsRequestBuilder } from './chats/index.js';
import { type CheckMemberGroupsRequestBuilder } from './checkMemberGroups/index.js';
import { type CheckMemberObjectsRequestBuilder } from './checkMemberObjects/index.js';
import { type CloudClipboardRequestBuilder } from './cloudClipboard/index.js';
import { type ContactFoldersRequestBuilder } from './contactFolders/index.js';
import { type ContactsRequestBuilder } from './contacts/index.js';
import { type CreatedObjectsRequestBuilder } from './createdObjects/index.js';
import { type DataSecurityAndGovernanceRequestBuilder } from './dataSecurityAndGovernance/index.js';
import { type DeviceManagementTroubleshootingEventsRequestBuilder } from './deviceManagementTroubleshootingEvents/index.js';
import { type DirectReportsRequestBuilder } from './directReports/index.js';
import { type DriveRequestBuilder } from './drive/index.js';
import { type DrivesRequestBuilder } from './drives/index.js';
import { type EmployeeExperienceRequestBuilder } from './employeeExperience/index.js';
import { type EventsRequestBuilder } from './events/index.js';
import { type ExportDeviceAndAppManagementDataRequestBuilder } from './exportDeviceAndAppManagementData/index.js';
import { type ExportDeviceAndAppManagementDataWithSkipWithTopRequestBuilder } from './exportDeviceAndAppManagementDataWithSkipWithTop/index.js';
import { type ExportPersonalDataRequestBuilder } from './exportPersonalData/index.js';
import { type ExtensionsRequestBuilder } from './extensions/index.js';
import { type FindMeetingTimesRequestBuilder } from './findMeetingTimes/index.js';
import { type FollowedSitesRequestBuilder } from './followedSites/index.js';
import { type GetMailTipsRequestBuilder } from './getMailTips/index.js';
import { type GetManagedAppDiagnosticStatusesRequestBuilder } from './getManagedAppDiagnosticStatuses/index.js';
import { type GetManagedAppPoliciesRequestBuilder } from './getManagedAppPolicies/index.js';
import { type GetManagedDevicesWithAppFailuresRequestBuilder } from './getManagedDevicesWithAppFailures/index.js';
import { type GetMemberGroupsRequestBuilder } from './getMemberGroups/index.js';
import { type GetMemberObjectsRequestBuilder } from './getMemberObjects/index.js';
import { type InferenceClassificationRequestBuilder } from './inferenceClassification/index.js';
import { type InsightsRequestBuilder } from './insights/index.js';
import { type JoinedTeamsRequestBuilder } from './joinedTeams/index.js';
import { type LicenseDetailsRequestBuilder } from './licenseDetails/index.js';
import { type MailboxSettingsRequestBuilder } from './mailboxSettings/index.js';
import { type MailFoldersRequestBuilder } from './mailFolders/index.js';
import { type ManagedAppRegistrationsRequestBuilder } from './managedAppRegistrations/index.js';
import { type ManagedDevicesRequestBuilder } from './managedDevices/index.js';
import { type ManagerRequestBuilder } from './manager/index.js';
import { type MemberOfRequestBuilder } from './memberOf/index.js';
import { type MessagesRequestBuilder } from './messages/index.js';
import { type Oauth2PermissionGrantsRequestBuilder } from './oauth2PermissionGrants/index.js';
import { type OnenoteRequestBuilder } from './onenote/index.js';
import { type OnlineMeetingsRequestBuilder } from './onlineMeetings/index.js';
import { type OutlookRequestBuilder } from './outlook/index.js';
import { type OwnedDevicesRequestBuilder } from './ownedDevices/index.js';
import { type OwnedObjectsRequestBuilder } from './ownedObjects/index.js';
import { type PeopleRequestBuilder } from './people/index.js';
import { type PermissionGrantsRequestBuilder } from './permissionGrants/index.js';
import { type PhotoRequestBuilder } from './photo/index.js';
import { type PhotosRequestBuilder } from './photos/index.js';
import { type PlannerRequestBuilder } from './planner/index.js';
import { type PresenceRequestBuilder } from './presence/index.js';
import { type RegisteredDevicesRequestBuilder } from './registeredDevices/index.js';
import { type ReminderViewWithStartDateTimeWithEndDateTimeRequestBuilder } from './reminderViewWithStartDateTimeWithEndDateTime/index.js';
import { type RemoveAllDevicesFromManagementRequestBuilder } from './removeAllDevicesFromManagement/index.js';
import { type ReprocessLicenseAssignmentRequestBuilder } from './reprocessLicenseAssignment/index.js';
import { type RestoreRequestBuilder } from './restore/index.js';
import { type RetryServiceProvisioningRequestBuilder } from './retryServiceProvisioning/index.js';
import { type RevokeSignInSessionsRequestBuilder } from './revokeSignInSessions/index.js';
import { type ScopedRoleMemberOfRequestBuilder } from './scopedRoleMemberOf/index.js';
import { type SendMailRequestBuilder } from './sendMail/index.js';
import { type ServiceProvisioningErrorsRequestBuilder } from './serviceProvisioningErrors/index.js';
import { type SettingsRequestBuilder } from './settings/index.js';
import { type SolutionsRequestBuilder } from './solutions/index.js';
import { type SponsorsRequestBuilder } from './sponsors/index.js';
import { type TeamworkRequestBuilder } from './teamwork/index.js';
import { type TodoRequestBuilder } from './todo/index.js';
import { type TransitiveMemberOfRequestBuilder } from './transitiveMemberOf/index.js';
import { type TranslateExchangeIdsRequestBuilder } from './translateExchangeIds/index.js';
import { type WipeManagedAppRegistrationsByDeviceTagRequestBuilder } from './wipeManagedAppRegistrationsByDeviceTag/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the collection of user entities.
*/
export interface UserItemRequestBuilder extends BaseRequestBuilder<UserItemRequestBuilder> {
/**
* Provides operations to manage the activities property of the microsoft.graph.user entity.
*/
get activities(): ActivitiesRequestBuilder;
/**
* Provides operations to manage the agreementAcceptances property of the microsoft.graph.user entity.
*/
get agreementAcceptances(): AgreementAcceptancesRequestBuilder;
/**
* Provides operations to manage the appRoleAssignments property of the microsoft.graph.user entity.
*/
get appRoleAssignments(): AppRoleAssignmentsRequestBuilder;
/**
* Provides operations to call the assignLicense method.
*/
get assignLicense(): AssignLicenseRequestBuilder;
/**
* Provides operations to manage the authentication property of the microsoft.graph.user entity.
*/
get authentication(): AuthenticationRequestBuilder;
/**
* Provides operations to manage the calendar property of the microsoft.graph.user entity.
*/
get calendar(): CalendarRequestBuilder;
/**
* Provides operations to manage the calendarGroups property of the microsoft.graph.user entity.
*/
get calendarGroups(): CalendarGroupsRequestBuilder;
/**
* Provides operations to manage the calendars property of the microsoft.graph.user entity.
*/
get calendars(): CalendarsRequestBuilder;
/**
* Provides operations to manage the calendarView property of the microsoft.graph.user entity.
*/
get calendarView(): CalendarViewRequestBuilder;
/**
* Provides operations to call the changePassword method.
*/
get changePassword(): ChangePasswordRequestBuilder;
/**
* Provides operations to manage the chats property of the microsoft.graph.user entity.
*/
get chats(): ChatsRequestBuilder;
/**
* Provides operations to call the checkMemberGroups method.
*/
get checkMemberGroups(): CheckMemberGroupsRequestBuilder;
/**
* Provides operations to call the checkMemberObjects method.
*/
get checkMemberObjects(): CheckMemberObjectsRequestBuilder;
/**
* Provides operations to manage the cloudClipboard property of the microsoft.graph.user entity.
*/
get cloudClipboard(): CloudClipboardRequestBuilder;
/**
* Provides operations to manage the contactFolders property of the microsoft.graph.user entity.
*/
get contactFolders(): ContactFoldersRequestBuilder;
/**
* Provides operations to manage the contacts property of the microsoft.graph.user entity.
*/
get contacts(): ContactsRequestBuilder;
/**
* Provides operations to manage the createdObjects property of the microsoft.graph.user entity.
*/
get createdObjects(): CreatedObjectsRequestBuilder;
/**
* Provides operations to manage the dataSecurityAndGovernance property of the microsoft.graph.user entity.
*/
get dataSecurityAndGovernance(): DataSecurityAndGovernanceRequestBuilder;
/**
* Provides operations to manage the deviceManagementTroubleshootingEvents property of the microsoft.graph.user entity.
*/
get deviceManagementTroubleshootingEvents(): DeviceManagementTroubleshootingEventsRequestBuilder;
/**
* Provides operations to manage the directReports property of the microsoft.graph.user entity.
*/
get directReports(): DirectReportsRequestBuilder;
/**
* Provides operations to manage the drive property of the microsoft.graph.user entity.
*/
get drive(): DriveRequestBuilder;
/**
* Provides operations to manage the drives property of the microsoft.graph.user entity.
*/
get drives(): DrivesRequestBuilder;
/**
* Provides operations to manage the employeeExperience property of the microsoft.graph.user entity.
*/
get employeeExperience(): EmployeeExperienceRequestBuilder;
/**
* Provides operations to manage the events property of the microsoft.graph.user entity.
*/
get events(): EventsRequestBuilder;
/**
* Provides operations to call the exportDeviceAndAppManagementData method.
*/
get exportDeviceAndAppManagementData(): ExportDeviceAndAppManagementDataRequestBuilder;
/**
* Provides operations to call the exportPersonalData method.
*/
get exportPersonalData(): ExportPersonalDataRequestBuilder;
/**
* Provides operations to manage the extensions property of the microsoft.graph.user entity.
*/
get extensions(): ExtensionsRequestBuilder;
/**
* Provides operations to call the findMeetingTimes method.
*/
get findMeetingTimes(): FindMeetingTimesRequestBuilder;
/**
* Provides operations to manage the followedSites property of the microsoft.graph.user entity.
*/
get followedSites(): FollowedSitesRequestBuilder;
/**
* Provides operations to call the getMailTips method.
*/
get getMailTips(): GetMailTipsRequestBuilder;
/**
* Provides operations to call the getManagedAppDiagnosticStatuses method.
*/
get getManagedAppDiagnosticStatuses(): GetManagedAppDiagnosticStatusesRequestBuilder;
/**
* Provides operations to call the getManagedAppPolicies method.
*/
get getManagedAppPolicies(): GetManagedAppPoliciesRequestBuilder;
/**
* Provides operations to call the getManagedDevicesWithAppFailures method.
*/
get getManagedDevicesWithAppFailures(): GetManagedDevicesWithAppFailuresRequestBuilder;
/**
* Provides operations to call the getMemberGroups method.
*/
get getMemberGroups(): GetMemberGroupsRequestBuilder;
/**
* Provides operations to call the getMemberObjects method.
*/
get getMemberObjects(): GetMemberObjectsRequestBuilder;
/**
* Provides operations to manage the inferenceClassification property of the microsoft.graph.user entity.
*/
get inferenceClassification(): InferenceClassificationRequestBuilder;
/**
* Provides operations to manage the insights property of the microsoft.graph.user entity.
*/
get insights(): InsightsRequestBuilder;
/**
* Provides operations to manage the joinedTeams property of the microsoft.graph.user entity.
*/
get joinedTeams(): JoinedTeamsRequestBuilder;
/**
* Provides operations to manage the licenseDetails property of the microsoft.graph.user entity.
*/
get licenseDetails(): LicenseDetailsRequestBuilder;
/**
* The mailboxSettings property
*/
get mailboxSettings(): MailboxSettingsRequestBuilder;
/**
* Provides operations to manage the mailFolders property of the microsoft.graph.user entity.
*/
get mailFolders(): MailFoldersRequestBuilder;
/**
* Provides operations to manage the managedAppRegistrations property of the microsoft.graph.user entity.
*/
get managedAppRegistrations(): ManagedAppRegistrationsRequestBuilder;
/**
* Provides operations to manage the managedDevices property of the microsoft.graph.user entity.
*/
get managedDevices(): ManagedDevicesRequestBuilder;
/**
* Provides operations to manage the manager property of the microsoft.graph.user entity.
*/
get manager(): ManagerRequestBuilder;
/**
* Provides operations to manage the memberOf property of the microsoft.graph.user entity.
*/
get memberOf(): MemberOfRequestBuilder;
/**
* Provides operations to manage the messages property of the microsoft.graph.user entity.
*/
get messages(): MessagesRequestBuilder;
/**
* Provides operations to manage the oauth2PermissionGrants property of the microsoft.graph.user entity.
*/
get oauth2PermissionGrants(): Oauth2PermissionGrantsRequestBuilder;
/**
* Provides operations to manage the onenote property of the microsoft.graph.user entity.
*/
get onenote(): OnenoteRequestBuilder;
/**
* Provides operations to manage the onlineMeetings property of the microsoft.graph.user entity.
*/
get onlineMeetings(): OnlineMeetingsRequestBuilder;
/**
* Provides operations to manage the outlook property of the microsoft.graph.user entity.
*/
get outlook(): OutlookRequestBuilder;
/**
* Provides operations to manage the ownedDevices property of the microsoft.graph.user entity.
*/
get ownedDevices(): OwnedDevicesRequestBuilder;
/**
* Provides operations to manage the ownedObjects property of the microsoft.graph.user entity.
*/
get ownedObjects(): OwnedObjectsRequestBuilder;
/**
* Provides operations to manage the people property of the microsoft.graph.user entity.
*/
get people(): PeopleRequestBuilder;
/**
* Provides operations to manage the permissionGrants property of the microsoft.graph.user entity.
*/
get permissionGrants(): PermissionGrantsRequestBuilder;
/**
* Provides operations to manage the photo property of the microsoft.graph.user entity.
*/
get photo(): PhotoRequestBuilder;
/**
* Provides operations to manage the photos property of the microsoft.graph.user entity.
*/
get photos(): PhotosRequestBuilder;
/**
* Provides operations to manage the planner property of the microsoft.graph.user entity.
*/
get planner(): PlannerRequestBuilder;
/**
* Provides operations to manage the presence property of the microsoft.graph.user entity.
*/
get presence(): PresenceRequestBuilder;
/**
* Provides operations to manage the registeredDevices property of the microsoft.graph.user entity.
*/
get registeredDevices(): RegisteredDevicesRequestBuilder;
/**
* Provides operations to call the removeAllDevicesFromManagement method.
*/
get removeAllDevicesFromManagement(): RemoveAllDevicesFromManagementRequestBuilder;
/**
* Provides operations to call the reprocessLicenseAssignment method.
*/
get reprocessLicenseAssignment(): ReprocessLicenseAssignmentRequestBuilder;
/**
* Provides operations to call the restore method.
*/
get restore(): RestoreRequestBuilder;
/**
* Provides operations to call the retryServiceProvisioning method.
*/
get retryServiceProvisioning(): RetryServiceProvisioningRequestBuilder;
/**
* Provides operations to call the revokeSignInSessions method.
*/
get revokeSignInSessions(): RevokeSignInSessionsRequestBuilder;
/**
* Provides operations to manage the scopedRoleMemberOf property of the microsoft.graph.user entity.
*/
get scopedRoleMemberOf(): ScopedRoleMemberOfRequestBuilder;
/**
* Provides operations to call the sendMail method.
*/
get sendMail(): SendMailRequestBuilder;
/**
* The serviceProvisioningErrors property
*/
get serviceProvisioningErrors(): ServiceProvisioningErrorsRequestBuilder;
/**
* Provides operations to manage the settings property of the microsoft.graph.user entity.
*/
get settings(): SettingsRequestBuilder;
/**
* Provides operations to manage the solutions property of the microsoft.graph.user entity.
*/
get solutions(): SolutionsRequestBuilder;
/**
* Provides operations to manage the sponsors property of the microsoft.graph.user entity.
*/
get sponsors(): SponsorsRequestBuilder;
/**
* Provides operations to manage the teamwork property of the microsoft.graph.user entity.
*/
get teamwork(): TeamworkRequestBuilder;
/**
* Provides operations to manage the todo property of the microsoft.graph.user entity.
*/
get todo(): TodoRequestBuilder;
/**
* Provides operations to manage the transitiveMemberOf property of the microsoft.graph.user entity.
*/
get transitiveMemberOf(): TransitiveMemberOfRequestBuilder;
/**
* Provides operations to call the translateExchangeIds method.
*/
get translateExchangeIds(): TranslateExchangeIdsRequestBuilder;
/**
* Provides operations to call the wipeManagedAppRegistrationsByDeviceTag method.
*/
get wipeManagedAppRegistrationsByDeviceTag(): WipeManagedAppRegistrationsByDeviceTagRequestBuilder;
/**
* Deletes a user.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/intune-mam-user-delete?view=graph-rest-1.0|Find more info here}
*/
delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
/**
* Provides operations to call the exportDeviceAndAppManagementData method.
* @param skip Usage: skip={skip}
* @param top Usage: top={top}
* @returns {ExportDeviceAndAppManagementDataWithSkipWithTopRequestBuilder}
*/
exportDeviceAndAppManagementDataWithSkipWithTop(skip: number | undefined, top: number | undefined): ExportDeviceAndAppManagementDataWithSkipWithTopRequestBuilder;
/**
* Read properties and relationships of the user object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<User>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/intune-onboarding-user-get?view=graph-rest-1.0|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<UserItemRequestBuilderGetQueryParameters> | undefined): Promise<User | undefined>;
/**
* Update the properties of a user object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<User>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/user-update?view=graph-rest-1.0|Find more info here}
*/
patch(body: User, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<User | undefined>;
/**
* Provides operations to call the reminderView method.
* @param EndDateTime Usage: EndDateTime='{EndDateTime}'
* @param StartDateTime Usage: StartDateTime='{StartDateTime}'
* @returns {ReminderViewWithStartDateTimeWithEndDateTimeRequestBuilder}
*/
reminderViewWithStartDateTimeWithEndDateTime(endDateTime: string | undefined, startDateTime: string | undefined): ReminderViewWithStartDateTimeWithEndDateTimeRequestBuilder;
/**
* Deletes a user.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
/**
* Read properties and relationships of the user object.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<UserItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Update the properties of a user object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPatchRequestInformation(body: User, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Read properties and relationships of the user object.
*/
export interface UserItemRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const UserItemRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}{?%24expand,%24select}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const UserItemRequestBuilderNavigationMetadata: Record<Exclude<keyof UserItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const UserItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map