Type de ressource Permission

La ressource Permission fournit des informations sur une autorisation de partage octroyée pour une ressource DriveItem.

Les autorisations de partage ont plusieurs formulaires différents. La ressource Permission représente ces différents formulaires au moyen de facettes sur la ressource.

Représentation JSON

Voici une représentation JSON de la ressource

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "grantedToIdentities": [{"@odata.type": "microsoft.graph.identitySet"}],
  "inheritedFrom": {"@odata.type": "microsoft.graph.itemReference"},
  "invitation": {"@odata.type": "microsoft.graph.sharingInvitation"},
  "link": {"@odata.type": "microsoft.graph.sharingLink"},
  "roles": ["string"],
  "shareId": "string"
}

Propriétés

Propriété Type Description
id String L’identificateur unique de l’autorisation parmi toutes les autorisations sur l’élément. En lecture seule.
grantedTo IdentitySet Pour les autorisations de type utilisateur, détails des utilisateurs et des applications pour cette autorisation. En lecture seule.
grantedToIdentities Collection(IdentitySet) Pour les autorisations de type lien, les détails des utilisateurs auxquels l’autorisation a été accordée. En lecture seule.
invitation SharingInvitation Détails d’une invitation de partage pour cette autorisation. En lecture seule.
inheritedFrom ItemReference Fournit une référence à l’ancêtre de l’autorisation actuelle, si elle est héritée d’un ancêtre. En lecture seule.
link SharingLink Fournit les informations de lien de l’autorisation actuelle, s’il s’agit d’une autorisation de type lien. En lecture seule.
roles Collection(String) Type d’autorisation, par exemple, read. Voir ci-dessous pour une liste complète des rôles. En lecture seule.
shareId String Jeton unique qui peut être utilisé pour accéder à cet élément partagé viapartages API. En lecture seule.

Énumération des rôles

Rôle Détails
read Permet de lire les métadonnées et le contenu de l’élément.
write Permet de lire et de modifier les métadonnées et le contenu de l’élément.
owner Pour SharePoint et OneDrive Entreprise, cela représente le rôle du propriétaire.
member Pour SharePoint et OneDrive Entreprise, cela représente le rôle du membre.

La ressource d’autorisation utilise des facettes pour fournir des informations sur le type d’autorisation représenté par la ressource.

Les liens de partage contiennent un jeton unique nécessaire pour accéder à l’élément.

Les autorisations avec une facette d’invitation représentent les autorisations ajoutées en invitant des utilisateurs ou des groupes spécifiques à accéder au fichier.

Les autorisations avec une facette link représentent les liens de partage créés sur l’élément. Il s’agit des types d’autorisations les plus courants. Les liens de partage fournissent une URL unique qui peut être utilisée pour accéder à un fichier ou à un dossier. Ils peuvent être configurés pour accorder l’accès de différentes manières. Par exemple, vous pouvez utiliser l'API createLink pour créer un lien qui s’applique à quiconque se connecte à votre organisation, ou vous pouvez créer un lien qui fonctionne pour tout le monde, sans avoir à se connecter. Vous pouvez utiliser l'API inviterpour créer un lien qui fonctionne uniquement pour des personnes spécifiques, qu’elles soient ou non au sein de votre entreprise.

Voici quelques exemples de liens de partage.

Un lien d’affichage offre un accès en lecture seule à toute personne disposant du lien.

{
  "id": "1",
  "roles": ["read"],
  "link": {
    "scope": "anonymous",
    "type": "view",
    "webUrl": "https://onedrive.live.com/redir?resid=5D33DD65C6932946!70859&authkey=!AL7N1QAfSWcjNU8&ithint=folder%2cgif",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

Ce lien de modification fournit l’accès en lecture et en écriture à tous les utilisateurs de l’organisation avec le lien.

{
  "id": "2ceefb3g32hh",
  "roles": ["write"],
  "link": {
    "scope": "organization",
    "type": "edit",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/fj277ghautbb422707565gnvg23",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

Ce lien fournit l’accès en lecture et en écriture aux personnes spécifiques de la collection grantedToIdentities.

{
  "id": "3",
  "grantedToIdentities": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

Invitations de partage

Les autorisations envoyées par l’API d’invitation peuvent contenir des informations supplémentaires dans la facette d’invitation . Si l’autorisation a été envoyée via une adresse de messagerie qui ne dispose pas d’un compte correspondant, la propriété grantedTo ne peut pas être définie avant que l’invitation ne soit utilisée, ce qui se produit la première fois qu’un utilisateur clique sur le lien et se connecte.

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"
}

Une fois que l’invitation de partage a été activée par un utilisateur, la propriété grantedTo contient les informations sur le compte qui a activé les autorisations :

{
  "id": "1",
  "roles": ["write"],
  "grantedTo": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "John Doe"
    }
  },
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"
}

Méthodes

Méthode Chemin d’accès REST
Autorisations de liste GET /drive/items/{item-id}/permissions
Obtenir une autorisation GET /drive/items/{item-id}/permissions/{id}
Créer un lien POST /drive/items/{item-id}/createLink
Inviter des personnes POST /drive/items/{item-id}/invite
Mettre à jour PATCH /drive/items/{item-id}/permissions/{id}
Supprimer DELETE /drive/items/{item-id}/permissions/{id}

Remarques

Les bibliothèques de documents OneDrive Entreprise et SharePoint ne renvoient pas la propriété inheritedFrom.