microsoft.graph.permission

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-onedrive/json-schema/microsoft-onedrive-microsoft-graph-permission-schema.json",
  "title": "microsoft.graph.permission",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-onedrive-drives-list-api-openapi.yml#/components/schemas/microsoft.graph.permission",
  "allOf": [
    {
      "$ref": "#/$defs/microsoft.graph.entity"
    },
    {
      "title": "permission",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "expirationDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": [
            "string",
            "null"
          ],
          "description": "A format of yyyy-MM-ddTHH:mm:ssZ of DateTimeOffset indicates the expiration time of the permission. DateTime.MinValue indicates there's no expiration set for this permission. Optional.",
          "format": "date-time"
        },
        "grantedTo": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.identitySet"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "For user type permissions, the details of the users and applications for this permission. Read-only."
        },
        "grantedToIdentities": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/microsoft.graph.identitySet"
          },
          "description": "For type permissions, the details of the users to whom permission was granted. Read-only."
        },
        "grantedToIdentitiesV2": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/microsoft.graph.sharePointIdentitySet"
          },
          "description": "For link type permissions, the details of the users to whom permission was granted. Read-only."
        },
        "grantedToV2": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.sharePointIdentitySet"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "For user type permissions, the details of the users and applications for this permission. Read-only."
        },
        "hasPassword": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. For OneDrive Personal only.."
        },
        "inheritedFrom": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.itemReference"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Provides a reference to the ancestor of the current permission, if it's inherited from an ancestor. Read-only."
        },
        "invitation": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.sharingInvitation"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Details of any associated sharing invitation for this permission. Read-only."
        },
        "link": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.sharingLink"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Provides the link details of the current permission, if it's a link type permission. Read-only."
        },
        "roles": {
          "type": "array",
          "items": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": "The type of permission, for example, read. See below for the full list of roles. Read-only."
        },
        "shareId": {
          "type": [
            "string",
            "null"
          ],
          "description": "A unique token that can be used to access this shared item via the shares API. Read-only."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.permission",
  "$defs": {
    "microsoft.graph.entity": {
      "title": "entity",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for an entity. Read-only."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.identity": {
      "title": "identity",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "displayName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The display name of the identity.For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta."
        },
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.identitySet": {
      "title": "identitySet",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "application": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.identity"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Optional. The application associated with this action."
        },
        "device": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.identity"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Optional. The device associated with this action."
        },
        "user": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.identity"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Optional. The user associated with this action."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.itemReference": {
      "title": "itemReference",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "driveId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique identifier of the drive instance that contains the driveItem. Only returned if the item is located in a drive. Read-only."
        },
        "driveType": {
          "type": [
            "string",
            "null"
          ],
          "description": "Identifies the type of drive. Only returned if the item is located in a drive. See drive resource for values."
        },
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique identifier of the driveItem in the drive or a listItem in a list. Read-only."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the item being referenced. Read-only."
        },
        "path": {
          "type": [
            "string",
            "null"
          ],
          "description": "Percent-encoded path that can be used to navigate to the item. Read-only."
        },
        "shareId": {
          "type": [
            "string",
            "null"
          ],
          "description": "A unique identifier for a shared resource that can be accessed via the Shares API."
        },
        "sharepointIds": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.sharepointIds"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Returns identifiers useful for SharePoint REST compatibility. Read-only."
        },
        "siteId": {
          "type": [
            "string",
            "null"
          ],
          "description": "For OneDrive for Business and SharePoint, this property represents the ID of the site that contains the parent document library of the driveItem resource or the parent list of the listItem resource. The value is the same as the id property of that site resource. It is an opaque string that consists of three identifiers of the site. For OneDrive, this property is not populated."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.sharePointGroupIdentity": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.identity"
        },
        {
          "title": "sharePointGroupIdentity",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "principalId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The principal ID of the SharePoint group in the tenant. Read-only."
            },
            "title": {
              "type": [
                "string",
                "null"
              ],
              "description": "The title of the SharePoint group. Read-only."
            },
            "@odata.type": {
              "type": "string",
              "default": "#microsoft.graph.sharePointGroupIdentity"
            }
          }
        }
      ],
      "x-ms-discriminator-value": "#microsoft.graph.sharePointGroupIdentity"
    },
    "microsoft.graph.sharePointIdentity": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.identity"
        },
        {
          "title": "sharePointIdentity",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "loginName": {
              "type": [
                "string",
                "null"
              ],
              "description": "The sign in name of the SharePoint identity."
            },
            "@odata.type": {
              "type": "string",
              "default": "#microsoft.graph.sharePointIdentity"
            }
          }
        }
      ],
      "x-ms-discriminator-value": "#microsoft.graph.sharePointIdentity"
    },
    "microsoft.graph.sharePointIdentitySet": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.identitySet"
        },
        {
          "title": "sharePointIdentitySet",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "group": {
              "anyOf": [
                {
                  "$ref": "#/$defs/microsoft.graph.identity"
                },
                {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              ],
              "description": "The group associated with this action. Optional."
            },
            "sharePointGroup": {
              "anyOf": [
                {
                  "$ref": "#/$defs/microsoft.graph.sharePointGroupIdentity"
                },
                {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              ],
              "description": "The SharePoint group associated with this action, identified by a globally unique ID. Use this property instead of siteGroup when available. Optional."
            },
            "siteGroup": {
              "anyOf": [
                {
                  "$ref": "#/$defs/microsoft.graph.sharePointIdentity"
                },
                {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              ],
              "description": "The SharePoint group associated with this action, identified by a principal ID that is unique only within the site. Optional."
            },
            "siteUser": {
              "anyOf": [
                {
                  "$ref": "#/$defs/microsoft.graph.sharePointIdentity"
                },
                {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              ],
              "description": "The SharePoint user associated with this action. Optional."
            },
            "@odata.type": {
              "type": "string",
              "default": "#microsoft.graph.sharePointIdentitySet"
            }
          }
        }
      ],
      "x-ms-discriminator-value": "#microsoft.graph.sharePointIdentitySet"
    },
    "microsoft.graph.sharepointIds": {
      "title": "sharepointIds",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "listId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The unique identifier (guid) for the item's list in SharePoint."
        },
        "listItemId": {
          "type": [
            "string",
            "null"
          ],
          "description": "An integer identifier for the item within the containing list."
        },
        "listItemUniqueId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The unique identifier (guid) for the item within OneDrive for Business or a SharePoint site."
        },
        "siteId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The unique identifier (guid) for the item's site collection (SPSite)."
        },
        "siteUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "The SharePoint URL for the site that contains the item."
        },
        "tenantId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The unique identifier (guid) for the tenancy."
        },
        "webId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The unique identifier (guid) for the item's site (SPWeb)."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.sharingInvitation": {
      "title": "sharingInvitation",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "email": {
          "type": [
            "string",
            "null"
          ],
          "description": "The email address provided for the recipient of the sharing invitation. Read-only."
        },
        "invitedBy": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.identitySet"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Provides information about who sent the invitation that created this permission, if that information is available. Read-only."
        },
        "redeemedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "signInRequired": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "If true the recipient of the invitation needs to sign in in order to access the shared item. Read-only."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.sharingLink": {
      "title": "sharingLink",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "application": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.identity"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "The app the link is associated with."
        },
        "preventsDownload": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "If true then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. Only for OneDrive for Business and SharePoint."
        },
        "scope": {
          "type": [
            "string",
            "null"
          ],
          "description": "The scope of the link represented by this permission. Value anonymous indicates the link is usable by anyone, organization indicates the link is only usable for users signed into the same tenant."
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "The type of the link created."
        },
        "webHtml": {
          "type": [
            "string",
            "null"
          ],
          "description": "For embed links, this property contains the HTML code for an <iframe> element that will embed the item in a webpage."
        },
        "webUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "A URL that opens the item in the browser on the OneDrive website."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  }
}