Create printerShare

Namespace: microsoft.graph

Create a new printerShare for the specified printer.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

To use the Universal Print service, the user or app's tenant must have an active Universal Print subscription, in addition to the permissions listed in the following table. The signed in user must be a Printer Administrator.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) PrinterShare.ReadWrite.All
Delegated (personal Microsoft account) Not Supported.
Application Not Supported.

HTTP request

POST /print/shares

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the printerShare object.

The following table shows the properties that can be provided when you create the printerShare.

Property Type Description Required?
printer microsoft.graph.printer The printer that this printer share is related to. Use the printer@odata.bind syntax, as shown in the following example. Yes
displayName String The name of the printer share that print clients should display. Maximum length allowed is 50 characters. Yes
allowAllUsers Boolean If true, all users and groups will be granted access to this printer share. This supersedes the allow lists defined by the allowedUsers and allowedGroups navigation properties. No

Response

If successful, this method returns a 201 Created response code and a printerShare object in the response body.

Examples

Request

POST https://graph.microsoft.com/v1.0/print/shares
Content-Type: application/json

{
  "displayName": "ShareName",
  "allowAllUsers": false,
  "printer@odata.bind": "https://graph.microsoft.com/v1.0/print/printers/{printerId}"
}

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#print/shares/$entity",
  "id": "d837c17b-3296-4384-a053-828d56e10f50",
  "displayName": "ShareName",
  "createdDateTime": "2020-02-04T00:00:00.0000000Z",
  "isAcceptingJobs": true,
  "allowAllUsers": false,
  "status": {
    "state": "ready",
    "details": [],
    "description": ""
  }
}