Microsoft Graph: Universal Print
Printers, printer shares, print jobs and print task definitions in Universal Print. This listing is one area of Microsoft Graph, the single REST API for…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Printers, printer shares, print jobs and print task definitions in Universal Print.
This listing is one area of Microsoft Graph, the single REST API for Microsoft 365, Outlook, OneDrive, Teams and Microsoft Entra ID. It holds 109 of the area's requests, the most direct ones first, generated from Microsoft's own OpenAPI description of Graph v1.0. The other areas (mail, calendar, files, Teams, users and more) are listed separately on the Microsoft page.
Get an access token
- Sign in to the Microsoft Entra admin center and open App registrations > New registration. For a quick test, the Graph Explorer signs you in and shows a token without registering anything.
- Under API permissions, add the Microsoft Graph permissions this area needs, for example:
Printer.Read.All,PrintJob.ReadWrite.All. Delegated permissions act as the signed-in user; application permissions act as the app itself and need an administrator's consent. - Under Certificates & secrets, create a client secret (keep it out of shared collections).
- Get a token from
https://login.microsoftonline.com/ /oauth2/v2.0/token: the authorization-code flow for a user, orgrant_type=client_credentialswithscope=https://graph.microsoft.com/.defaultfor an app. Send it asAuthorization: Bearer.
Using these requests
- Base URL:
https://graph.microsoft.com/v1.0./me/...paths act on the signed-in user; with an application token use/users/{id or userPrincipalName}/...instead. - Shape responses with OData query parameters:
$select(fields),$filter,$orderby,$top,$expandand$search(some need theConsistencyLevel: eventualheader). Long lists are paged: follow@odata.nextLink. - Combine up to 20 requests in one call with
POST /$batch.
Common errors
| Status | Code | What to do |
|---|---|---|
| 401 | InvalidAuthenticationToken | The token is missing, expired or for another resource: get a new one for https://graph.microsoft.com. |
| 403 | Authorization_RequestDenied / ErrorAccessDenied | Add the permission listed in the request's docs and grant consent. |
| 404 | ResourceNotFound / itemNotFound | Check the id; ids from another user or tenant are not found. |
| 429 | TooManyRequests | Throttled: wait the Retry-After seconds, then retry. |
Docs: Universal Print overview · Permissions reference · Throttling
Endpoints 109
- GETGet print
/print - PATCHUpdate print
/print
Print: shares
- GETList shares
/print/sharesRetrieve a list of printerShares. - POSTCreate share
/print/sharesCreate a new printerShare for the specified printer. - GETGet share
/print/shares/:printerShare-idRetrieve the properties and relationships of a printer share. - DELETEDelete share
/print/shares/:printerShare-idDelete a printer share (unshare the associated printer). This action can't be undone. If the printer is shared again in the future, any Windows users who had… - PATCHUpdate share
/print/shares/:printerShare-idUpdate the properties of a printer share. This method can be used to swap printers. For example, if a physical printer device breaks, an administrator can… - GETList jobs
/print/shares/:printerShare-id/jobsRetrieve a list of print jobs associated with the printerShare. - POSTCreate job
/print/shares/:printerShare-id/jobsCreate a new printJob for a printerShare. Also creates a new printDocument associated with the printJob. - GETGet printer
/print/shares/:printerShare-id/printerThe printer that this printer share is related to. - GETList allowed users
/print/shares/:printerShare-id/allowedUsersRetrieve a list of users who have been granted access to submit print jobs to the associated printerShare. - GETList allowed groups
/print/shares/:printerShare-id/allowedGroupsRetrieve a list of groups that have been granted access to submit print jobs to the associated printerShare. - GETList shares references
/print/shares/:printerShare-id/allowedUsers/$refRetrieve a list of users who have been granted access to submit print jobs to the associated printerShare. - POSTAdd share reference
/print/shares/:printerShare-id/allowedUsers/$refGrant the specified user access to submit print jobs to the associated printerShare. - DELETERemove share reference
/print/shares/:printerShare-id/allowedUsers/$ref?@id=stringRevoke the specified user's access to submit print jobs to the associated printerShare. - GETList shares references
/print/shares/:printerShare-id/allowedGroups/$refRetrieve a list of groups that have been granted access to submit print jobs to the associated printerShare. - POSTAdd share reference
/print/shares/:printerShare-id/allowedGroups/$refGrant the specified group access to submit print jobs to the associated printerShare. - DELETERemove share reference
/print/shares/:printerShare-id/allowedGroups/$ref?@id=stringRevoke the specified group's access to submit print jobs to the associated printerShare. - GETGet job
/print/shares/:printerShare-id/jobs/:printJob-idThe list of jobs that are queued for printing by the printer/printerShare. - DELETEDelete job
/print/shares/:printerShare-id/jobs/:printJob-id - PATCHUpdate job
/print/shares/:printerShare-id/jobs/:printJob-id - POSTCreate abort
/print/shares/:printerShare-id/jobs/:printJob-id/abortAbort a print job. Only applications using application permissions can abort a print job. Aborting a print job will only succeed if there is a printTask in a… - POSTStart job
/print/shares/:printerShare-id/jobs/:printJob-id/startSubmits the print job to the associated printer or printerShare. It will be printed after any existing pending jobs are completed, aborted, or canceled. - GETList tasks
/print/shares/:printerShare-id/jobs/:printJob-id/tasksA list of printTasks that were triggered by this print job. - POSTCreate task
/print/shares/:printerShare-id/jobs/:printJob-id/tasks - POSTCancel job
/print/shares/:printerShare-id/jobs/:printJob-id/cancelCancel a print job. Print jobs can be canceled only on behalf of a user, using delegated permissions. - DELETERemove share reference
/print/shares/:printerShare-id/allowedUsers/:user-id/$refRevoke the specified user's access to submit print jobs to the associated printerShare. - POSTRedirect job
/print/shares/:printerShare-id/jobs/:printJob-id/redirectRedirect a print job to a different printer. Redirecting a print job will only succeed if there is a printTask in a processing state on the associated print… - GETList documents
/print/shares/:printerShare-id/jobs/:printJob-id/documents - POSTCreate document
/print/shares/:printerShare-id/jobs/:printJob-id/documents - DELETERemove share reference
/print/shares/:printerShare-id/allowedGroups/:group-id/$refRevoke the specified group's access to submit print jobs to the associated printerShare. - GETGet mailbox settings
/print/shares/:printerShare-id/allowedUsers/:user-id/mailboxSettingsSettings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time… - PATCHUpdate mailbox settings
/print/shares/:printerShare-id/allowedUsers/:user-id/mailboxSettings - GETList service provisioning errors
/print/shares/:printerShare-id/allowedUsers/:user-id/serviceProvisioningErrorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports… - GETList service provisioning errors
/print/shares/:printerShare-id/allowedGroups/:group-id/serviceProvisioningErrorsErrors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports… - GETGet task
/print/shares/:printerShare-id/jobs/:printJob-id/tasks/:printTask-idA list of printTasks that were triggered by this print job. - DELETEDelete task
/print/shares/:printerShare-id/jobs/:printJob-id/tasks/:printTask-id - PATCHUpdate task
/print/shares/:printerShare-id/jobs/:printJob-id/tasks/:printTask-id - GETGet document
/print/shares/:printerShare-id/jobs/:printJob-id/documents/:printDocument-id - DELETEDelete document
/print/shares/:printerShare-id/jobs/:printJob-id/documents/:printDocument-id - PATCHUpdate document
/print/shares/:printerShare-id/jobs/:printJob-id/documents/:printDocument-id
Print: printers
- GETList printers
/print/printersRetrieve the list of printers that are registered in the tenant. - POSTCreate printer
/print/printers - POSTCreate printer
/print/printers/createCreate (register) a printer with the Universal Print service. This is a long-running operation and as such, it returns a printerCreateOperation that can be… - GETGet printer
/print/printers/:printer-idRetrieve the properties and relationships of a printer object. - DELETEDelete printer
/print/printers/:printer-idDelete (unregister) a printer. - PATCHUpdate printer
/print/printers/:printer-idUpdate the properties of a printer object. - GETList jobs
/print/printers/:printer-id/jobsRetrieve a list of print jobs associated with the printer. - POSTCreate job
/print/printers/:printer-id/jobsCreate a new printJob for a printer. Also creates a new printDocument associated with the printJob. - GETList shares
/print/printers/:printer-id/sharesRetrieve a list of printer shares associated with the printer. - GETList connectors
/print/printers/:printer-id/connectorsRetrieve a list of printConnectors associated with the printer. - GETList task triggers
/print/printers/:printer-id/taskTriggersRetrieve a list of task triggers associated with the printer. The list of task triggers defines which tasks will be triggered as a result of events that occur… - POSTCreate task trigger
/print/printers/:printer-id/taskTriggersCreate a new task trigger on the specified printer. Currently, only one task trigger can be specified per printer, but this limit might be removed in the… - POSTRestore factory defaults (printer)
/print/printers/:printer-id/restoreFactoryDefaultsRestore a printer's default settings to the values specified by the manufacturer. - GETGet job
/print/printers/:printer-id/jobs/:printJob-idRetrieve the properties and relationships of a print job. - DELETEDelete job
/print/printers/:printer-id/jobs/:printJob-id - PATCHUpdate job
/print/printers/:printer-id/jobs/:printJob-idUpdate a print job. Only the configuration property can be updated. Updating a print job will only succeed if there is a printTask in a processing state on… - GETGet share
/print/printers/:printer-id/shares/:printerShare-idThe list of printerShares that are associated with the printer. Currently, only one printerShare can be associated with the printer. Read-only. Nullable. - GETGet connector
/print/printers/:printer-id/connectors/:printConnector-idThe connectors that are associated with the printer. - GETGet task trigger
/print/printers/:printer-id/taskTriggers/:printTaskTrigger-idGet a task trigger from a printer. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to… - DELETEDelete task trigger
/print/printers/:printer-id/taskTriggers/:printTaskTrigger-idDelete the task trigger of a printer to prevent related print events from triggering tasks on the specified printer. - PATCHUpdate task trigger
/print/printers/:printer-id/taskTriggers/:printTaskTrigger-id - POSTCreate abort
/print/printers/:printer-id/jobs/:printJob-id/abortAbort a print job. Only applications using application permissions can abort a print job. Aborting a print job will only succeed if there is a printTask in a… - POSTStart job
/print/printers/:printer-id/jobs/:printJob-id/startSubmits the print job to the associated printer or printerShare. It will be printed after any existing pending jobs are completed, aborted, or canceled. - GETList tasks
/print/printers/:printer-id/jobs/:printJob-id/tasksA list of printTasks that were triggered by this print job. - POSTCreate task
/print/printers/:printer-id/jobs/:printJob-id/tasks - POSTCancel job
/print/printers/:printer-id/jobs/:printJob-id/cancelCancel a print job. Print jobs can be canceled only on behalf of a user, using delegated permissions. - POSTRedirect job
/print/printers/:printer-id/jobs/:printJob-id/redirectRedirect a print job to a different printer. Redirecting a print job will only succeed if there is a printTask in a processing state on the associated print… - GETList documents
/print/printers/:printer-id/jobs/:printJob-id/documentsDownload the binary file associated with a printDocument. Calling this method yields a redirect response with a preauthenticated URL that can be used to… - POSTCreate document
/print/printers/:printer-id/jobs/:printJob-id/documents - GETGet definition
/print/printers/:printer-id/taskTriggers/:printTaskTrigger-id/definitionAn abstract definition that is used to create a printTask when triggered by a print event. Read-only. - GETGet task
/print/printers/:printer-id/jobs/:printJob-id/tasks/:printTask-idA list of printTasks that were triggered by this print job. - DELETEDelete task
/print/printers/:printer-id/jobs/:printJob-id/tasks/:printTask-id - PATCHUpdate task
/print/printers/:printer-id/jobs/:printJob-id/tasks/:printTask-id - GETGet document
/print/printers/:printer-id/jobs/:printJob-id/documents/:printDocument-id - DELETEDelete document
/print/printers/:printer-id/jobs/:printJob-id/documents/:printDocument-id - PATCHUpdate document
/print/printers/:printer-id/jobs/:printJob-id/documents/:printDocument-id
Print: services
- GETList services
/print/servicesRetrieve a list of printService objects that represent the services available to your tenant. - POSTCreate service
/print/services - GETGet service
/print/services/:printService-idRetrieve the properties and relationships of a print service. - DELETEDelete service
/print/services/:printService-id - PATCHUpdate service
/print/services/:printService-id - GETList endpoints
/print/services/:printService-id/endpointsRetrieve a list of endpoints exposed by a print service. - POSTCreate endpoint
/print/services/:printService-id/endpoints - GETGet endpoint
/print/services/:printService-id/endpoints/:printServiceEndpoint-idRetrieve the properties and relationships of a print service endpoint. - DELETEDelete endpoint
/print/services/:printService-id/endpoints/:printServiceEndpoint-id - PATCHUpdate endpoint
/print/services/:printService-id/endpoints/:printServiceEndpoint-id
Print: connectors
- GETList connectors
/print/connectorsRetrieve a list of print connectors. - POSTCreate connector
/print/connectors - GETGet connector
/print/connectors/:printConnector-idRetrieve the properties and relationships of a printConnector object. - DELETEDelete connector
/print/connectors/:printConnector-idDelete (unregister) a printConnector. - PATCHUpdate connector
/print/connectors/:printConnector-idUpdate the properties of a printConnector object.
Print: operations
- GETList operations
/print/operationsRetrieve the properties and relationships of a printOperation object. - POSTCreate operation
/print/operations - GETGet operation
/print/operations/:printOperation-idRetrieve the properties and relationships of a printOperation object. - DELETEDelete operation
/print/operations/:printOperation-id - PATCHUpdate operation
/print/operations/:printOperation-id
Print: task definitions
- GETList task definitions
/print/taskDefinitionsRetrieve a list of task definitions that the requesting app defined in the tenant. For details about how to use this API to add pull printing support to… - POSTCreate task definition
/print/taskDefinitionsCreate a new task definition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support… - GETGet task definition
/print/taskDefinitions/:printTaskDefinition-idGet details about a task definition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to… - DELETEDelete task definition
/print/taskDefinitions/:printTaskDefinition-idDelete a taskDefinition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull… - PATCHUpdate task definition
/print/taskDefinitions/:printTaskDefinition-idUpdate a task definition. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull… - GETList tasks
/print/taskDefinitions/:printTaskDefinition-id/tasksRetrieve a list of tasks associated with a task definition. For details about how to use this API to add pull printing support to Universal Print, see… - POSTCreate task
/print/taskDefinitions/:printTaskDefinition-id/tasks - GETGet task
/print/taskDefinitions/:printTaskDefinition-id/tasks/:printTask-idGet details about a print task. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to… - DELETEDelete task
/print/taskDefinitions/:printTaskDefinition-id/tasks/:printTask-id - PATCHUpdate task
/print/taskDefinitions/:printTaskDefinition-id/tasks/:printTask-idUpdate a print task. For details about how to use this API to add pull printing support to Universal Print, see Extending Universal Print to support pull… - GETGet trigger
/print/taskDefinitions/:printTaskDefinition-id/tasks/:printTask-id/triggerThe printTaskTrigger that triggered this task's execution. Read-only. - GETGet definition
/print/taskDefinitions/:printTaskDefinition-id/tasks/:printTask-id/definitionThe printTaskDefinition that was used to create this task. Read-only.
API details
- Base URL
https://graph.microsoft.com/v1.0- Authentication
- OAuth 2.0 (authorization code, client credentials flows)
- Operations
- 109 operations on 58 pathsGET 46POST 27DELETE 19PATCH 17
- Main resources
- Print: shares 39Print: printers 36Print: task definitions 12Print: services 10Print: connectors 5Print: operations 5Print 2
- Description format
- OpenAPI 3.0.4, API version
v1.0 - Links
- Documentation · OpenAPI document
How to test the Microsoft Graph: Universal Print in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Microsoft Graph: Universal Print collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get print” (GET /print), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Microsoft Graph: Universal Print?
Printers, printer shares, print jobs and print task definitions in Universal Print. This listing is one area of Microsoft Graph, the single REST API for… It is listed under Developer tools and has 109 endpoints.
Who publishes the Microsoft Graph: Universal Print?
It is listed from Microsoft's public API description (an OpenAPI document), not published by Microsoft on Swastik Codes. Anyone who controls microsoft.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Microsoft Graph: Universal Print?
Requests go to https://graph.microsoft.com/v1.0. Endpoint paths are added to this base URL.
How do I authenticate with the Microsoft Graph: Universal Print?
With OAuth 2.0 (authorization code, client credentials flows).
How many endpoints does the Microsoft Graph: Universal Print have?
109 operations on 58 paths (46 GET, 27 POST, 19 DELETE, 17 PATCH). The largest groups are Print: shares, Print: printers, Print: task definitions, Print: services.
Is forking the Microsoft Graph: Universal Print free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.