type de ressource d’autorisation

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

La ressource d’autorisation fournit des informations sur une autorisation de partage accordée pour une ressource driveItem .

Les autorisations de partage ont de nombreuses formes différentes. La ressource d’autorisation représente ces différents formulaires par le biais de facettes sur la ressource.

Remarque : les bibliothèques de documents OneDrive Entreprise et SharePoint ne retournent pas la propriété inheritedFrom.

OneDrive Entreprise et les bibliothèques de documents SharePoint ne retournent pas la propriété inheritedFrom. grantedTo et grantedToIdentities seront supprimés à l’avenir et la réponse sera migrée vers grantedToV2 et grantedToIdentitiesV2 respectivement sous les noms de propriété appropriés.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

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

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.
grantedToV2 SharePointIdentitySet Pour les autorisations de type utilisateur, les détails des utilisateurs et des applications pour cette autorisation. En lecture seule.
grantedToIdentitiesV2 Collection(SharePointIdentitySet) 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 détails du lien de l’autorisation actuelle, s’il s’agit d’une autorisation de type de lien. En lecture seule.
roles Collection(String) Type d’autorisation, par exemple, read. Consultez la section Valeurs de propriété Roles pour obtenir la 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.
expirationDateTime DateTimeOffset La ressource Permission fournit des informations sur une autorisation de partage octroyée pour une ressource DriveItem. DateTime.MinValue indique qu’aucune expiration n’est définie pour cette autorisation. Facultatif.
hasPassword Boolean Indique si le mot de passe est définie pour cette autorisation. Cette propriété apparaît uniquement dans la réponse. Facultatif. En lecture seule. Pour OneDrive Personnel uniquement.
grantedTo (deprecated) IdentitySet Pour les autorisations de type utilisateur, les détails des utilisateurs et des applications pour cette autorisation. En lecture seule.
grantedToIdentities (deprecated) Collection(IdentitySet) Pour les autorisations de type, les détails des utilisateurs auxquels l’autorisation a été accordée. En lecture seule.

Valeurs des propriétés des rôles

Valeur Description
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.

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 façons. 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",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Ce lien n’accorde aucun privilège supplémentaire à l’utilisateur.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "roles": ["read"],
  "link": {
    "scope": "existingAccess",
    "type": "view",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/Shared%20Documents/SampleDoc.docx?d=w12345",
  },
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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"
      }
    }
  ],
  "grantedToIdentitiesV2": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      },
      "siteUser": {
        "id": "1",
        "displayName": "Misty Suarez",
        "loginName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      },
      "siteUser": {
        "id": "2",
        "displayName": "Judith Clemons",
        "loginName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Partage d’invitations

Les autorisations envoyées par l’API d’invitation ou d’octroi peuvent contenir des informations supplémentaires dans la facette d’invitation pour les adresses e-mail qui ne correspondent pas à un compte connu. Dans ce cas, la propriété grantedTo peut ne pas être définie tant que le lien d’invitation n’est pas utilisé, ce qui se produit la première fois que l’utilisateur clique sur le lien et se connecte.

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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": "Robin Danielsen"
    }
  },
  "grantedToV2": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    },
    "siteUser": {
      "id": "1",
      "displayName": "Robin Danielsen",
      "loginName": "Robin Danielsen"
    }
  },
  "invitation": {
    "email": "rd@contoso.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

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}
Delete DELETE /drive/items/{item-id}/permissions/{id}
Partager le lien avec d'autres utilisateurs POST /shares/{encoded-sharing-url}/permission/grant
Révoquer des octrois POST /drive/items/{item-id}/permissions/{id}/revokeGrants