Show / Hide Table of Contents

Printer.ReadWrite.All

Allows the application to read and update printers on behalf of the signed-in user. Does not allow creating (registering) or deleting (unregistering) printers.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
Beta D DELETE /print/printers/{id}/taskTriggers/{id}
V1 D DELETE /print/printers/{printerId}/taskTriggers/{printTaskTriggerId}
Beta D GET /print/operations/{id}
V1 D GET /print/operations/{printOperationId}
V1 D GET /print/printers
V1 A,D GET /print/printers/{id}
Beta D GET /print/printers/{id}/getCapabilities
Beta D GET /print/printers/{id}/taskTriggers
Beta D GET /print/printers/{id}/taskTriggers/{id}
V1 D GET /print/printers/{printerId}/taskTriggers
V1 D GET /print/printers/{printerId}/taskTriggers/{printTaskTriggerId}
V1 D GET /print/services
Beta D GET /print/services/{id}
Beta D GET /print/services/{id}/endpoints
Beta D GET /print/services/{id}/endpoints/{name}
V1 D GET /print/services/{printServiceId}
V1 D GET /print/services/{printServiceId}/endpoints
V1 D GET /print/services/{printServiceId}/endpoints/{printServiceEndpointId}
V1 A,D GET /print/shares/{id}/printer
Beta A,D PATCH /print/printers/{id}
V1 A,D PATCH /print/printers/{printerId}
Beta D POST /print/printers/{id}/restoreFactoryDefaults
Beta D POST /print/printers/{id}/taskTriggers
V1 D POST /print/printers/{printerId}/restoreFactoryDefaults
V1 D POST /print/printers/{printerId}/taskTriggers
V1 D POST /print/printers/create

Delegate Permission

Id 89f66824-725f-4b8f-928e-e1c5258dc565
Consent Type Admin
Display String Read and update printers
Description Allows the application to read and update printers on behalf of the signed-in user. Does not allow creating (registering) or deleting (unregistering) printers.

Application Permission

Id f5b3f73d-6247-44df-a74c-866173fddab0
Display String Read and update printers
Description Allows the application to read and update printers without a signed-in user. Does not allow creating (registering) or deleting (unregistering) printers.

Resources

printCertificateSigningRequest

Property Type Description
content String A base64-encoded pkcs10 certificate request. Read-only.
transportKey String The base64-encoded public portion of an asymmetric key that is generated by the client. Read-only.

printer

Property Type Description
id String The document's identifier. Inherited from printerBase. Read-only.
displayName String The name of the printer. Inherited from printerBase.
manufacturer String The manufacturer reported by the printer. Inherited from printerBase.
model String The model name reported by the printer. Inherited from printerBase.
registeredDateTime DateTimeOffset The DateTimeOffset when the printer was registered. Read-only.
status printerStatus The processing status of the printer, including any errors. Inherited from printerBase.
isShared Boolean True if the printer is shared; false otherwise. Read-only.
hasPhysicalDevice Boolean True if the printer has a physical device for printing. Read-only.
isAcceptingJobs Boolean Whether the printer is currently accepting new print jobs. Inherited from printerBase.
location printerLocation The physical and/or organizational location of the printer. Inherited from printerBase.
defaults printerDefaults The printer's default print settings. Inherited from printerBase.
capabilities printerCapabilities The capabilities of the printer associated with this printer share. Inherited from printerBase.
lastSeenDateTime DateTimeOffset The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.

printerCapabilities

Property Type Description
contentTypes String collection A list of supported content (MIME) types that the printer supports. It is not guaranteed that the Universal Print service supports printing all of these MIME types.
isColorPrintingSupported Boolean True if color printing is supported by the printer; false otherwise. Read-only.
feedOrientations printerFeedOrientation collection The list of feed orientations that are supported by the printer.
isPageRangeSupported Boolean True if the printer supports printing by page ranges; false otherwise.
qualities printQuality collection The print qualities supported by the printer.
dpis Int32 collection The list of print resolutions in DPI that are supported by the printer.
duplexModes printDuplexMode collection The list of duplex modes that are supported by the printer. Valid values are described in the following table.
queueBufferSizeInBytes Int32 The maximum print job queue size that can be stored by the printer.
copiesPerJob integerRange The range of copies per job supported by the printer.
finishings printFinishing collection Finishing processes the printer supports for a printed document.
mediaColors String collection The media (i.e., paper) colors supported by the printer.
mediaTypes String collection The media types supported by the printer.
mediaSizes String collection The media sizes supported by the printer. Supports standard size names for ISO and ANSI media sizes. Valid values are in the following table.
pagesPerSheet Int32 collection Supported number of Input Pages to impose upon a single Impression.
orientations printOrientation collection The print orientations supported by the printer. Valid values are described in the following table.
inputBins String collection Supported input bins for the printer.
outputBins String collection The printer's supported output bins (trays).
supportsFitPdfToPage Boolean True if the printer supports scaling PDF pages to match the print media size; false otherwise.
multipageLayouts printMultipageLayout collection The presentation directions supported by the printer. Supported values are described in the following table.
colorModes printColorMode collection The color modes supported by the printer. Valid values are described in the following table.
topMargins Int32 collection A list of supported top margins(in microns) for the printer.
bottomMargins Int32 collection A list of supported bottom margins(in microns) for the printer.
rightMargins Int32 collection A list of supported right margins(in microns) for the printer.
leftMargins Int32 collection A list of supported left margins(in microns) for the printer.
collation Boolean True if the printer supports collating when printing muliple copies of a multi-page document; false otherwise.
scalings printScaling collection Supported print scalings.

printerCreateOperation

Property Type Description
id String The operation's identifier. Read-only.
status printOperationStatus The status of the registration operation. Contains the operation's progress and whether it completed successfully. Read-only.
createdDateTime DateTimeOffset The DateTimeOffset when the operation was created. Read-only.
certificate String The signed certificate created during the registration process. Read-only.

printerDefaults

Property Type Description
copiesPerJob Int32 The default number of copies printed per job.
contentType String The default content (MIME) type to use when processing documents.
finishings printFinishing collection The default set of finishings to apply to print jobs. Valid values are described in the following table.
mediaColor String The default media (such as paper) color to print the document on.
mediaType String The default media (such as paper) type to print the document on.
mediaSize String The default media size to use. Supports standard size names for ISO and ANSI media sizes. Valid values are listed in the printerCapabilities topic.
pagesPerSheet Int32 The default number of document pages to print on each sheet.
orientation printOrientation The default orientation to use when printing the document. Valid values are described in the following table.
outputBin String The default output bin to place completed prints into. See the printer's capabilities for a list of supported output bins.
fitPdfToPage Boolean The default fitPdfToPage setting. True to fit each page of a PDF document to a physical sheet of media; false to let the printer decide how to lay out impressions.
multipageLayout printMultipageLayout The default direction to lay out pages when multiple pages are being printed per sheet. Valid values are described in the following table.
colorMode printColorMode The default color mode to use when printing the document. Valid values are described in the following table.
quality printQuality The default quality to use when printing the document. Valid values are described in the following table.
duplexMode printDuplexMode The default duplex (double-sided) configuration to use when printing a document. Valid values are described in the following table.
dpi Int32 The default resolution in DPI to use when printing the job.
scaling printScaling Specifies how the printer scales the document data to fit the requested media. Valid values are described in the following table.

printerLocation

Property Type Description
latitude Double The latitude that the printer is located at.
longitude Double The longitude that the printer is located at.
altitudeInMeters Int32 The altitude, in meters, that the printer is located at.
streetAddress String The street address where the printer is located.
subUnit String collection The subunit hierarchy where the printer is located. The elements should be in hierarchical order. For example, if a campus is divided into different sections, the hierarchy might look like this: ["East Wing", "Block A"]
city String The city that the printer is located in.
postalCode String The postal code that the printer is located in.
countryOrRegion String The country or region that the printer is located in.
site String The site that the printer is located in.
building String The building that the printer is located in.
floor String The floor that the printer is located on. Only numerical values are supported right now.
floorDescription String The description of the floor that the printer is located on.
roomName String The room that the printer is located in. Only numerical values are supported right now.
roomDescription String The description of the room that the printer is located in.
organization String collection The organizational hierarchy that the printer belongs to. The elements should be in hierarchical order.
subdivision String collection The subdivision that the printer is located in. The elements should be in hierarchical order.
stateOrProvince String The state or province that the printer is located in.

printerStatus

Property Type Description
state printerProcessingState The current processing state. Valid values are described in the following table. Read-only.
details printerProcessingStateDetail collection The list of details describing why the printer is in the current state. Valid values are described in the following table. Read-only.
description String A human-readable description of the printer's current processing state. Read-only.

printOperation

Property Type Description
id String The operation's identifier. Read-only.
status printOperationStatus The status of the operation. Read-only.
createdDateTime DateTimeOffset The DateTimeOffset when the operation was created. Read-only.

printService

Property Type Description
id String The service's identifier. Read-only.

printServiceEndpoint

Property Type Description
displayName String A human-readable display name for the endpoint.
id String A unique name that identifies the service that the endpoint provides. Possible values are: discovery (Discovery Service), notification (Notification Service), ipp (IPP Service), and registration (Registration Service). Read-only.
uri String The URI that can be used to access the service.

printTaskDefinition

Property Type Description
id String The printTaskDefinition's identifier. Read-only.
displayName String The name of the printTaskDefinition.
createdBy appIdentity The application that created the printTaskDefinition. Read-only.

printTaskTrigger

Property Type Description
id String The printTaskTrigger's identifier. Read-only.
event printEvent The Universal Print event that will cause a new printTask to be triggered. Valid values are described in the following table.
In This Article
Back to top Created by merill | Submit feedback