Obtenir un lecteur

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 .

Récupérez les propriétés et les relations d’une ressource de lecteur .

Un lecteur est le conteneur de niveau supérieur d’un système de fichiers, tel que les bibliothèques de documents OneDrive ou SharePoint.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Files.Read Files. Read.All, Files. ReadWrite, Files. ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All, User.Read
Déléguée (compte Microsoft personnel) Files.Read Files. Read.All, Files. ReadWrite, Files. ReadWrite.All
Application Non prise en charge. Non prise en charge.

Requête HTTP

Obtenir le OneDrive actuel d’un utilisateur

Le lecteur de l’utilisateur connecté (lorsque vous utilisez l’authentification déléguée) est accessible à partir du me singleton.

Si un utilisateur dispose d’une licence pour OneDrive mais que son OneDrive n’est pas encore configuré, cette demande provisionne automatiquement le lecteur de l’utilisateur, lors de l’utilisation de l’authentification déléguée.

GET /me/drive

Obtenir le OneDrive d’un utilisateur

Pour accéder au lecteur OneDrive ou OneDrive Entreprise d’un utilisateur, votre application doit demander la relation drive sur la ressource User.

Si un utilisateur dispose d’une licence pour OneDrive mais que son OneDrive n’est pas encore configuré, cette demande provisionne automatiquement le lecteur de l’utilisateur, lors de l’utilisation de l’authentification déléguée.

GET /users/{idOrUserPrincipalName}/drive

Paramètres du chemin d’accès

Nom du paramètre Valeur Description
idOrUserPrincipalName string Obligatoire. Identificateur de l’objet de l’utilisateur propriétaire du lecteur OneDrive.

Obtenir la bibliothèque de documents associée à un groupe

Pour accéder à la bibliothèque de documents par défaut d’un groupe, votre application demande la relation drive sur la ressource Group.

GET /groups/{groupId}/drive

Paramètres du chemin d’accès

Nom du paramètre Valeur Description
groupId string Obligatoire. Identificateur pour le groupe propriétaire de la bibliothèque de documents.

Obtenir la bibliothèque de documents pour un site

Pour accéder à la bibliothèque de documents par défaut d’un site, votre application demande la relation drive sur la ressource Site.

GET /sites/{siteId}/drive

Paramètres du chemin d’accès

Nom du paramètre Valeur Description
siteId string Obligatoire. Identificateur du site contenant la bibliothèque de documents.

Obtenir un lecteur par le biais de son ID

Si vous disposez de l’identificateur unique d’un lecteur, vous pouvez y accéder directement à partir de la collection de lecteurs de niveau supérieur.

GET /drives/{driveId}

Paramètres du chemin d’accès

Nom du paramètre Valeur Description
driveId string Obligatoire. Identificateur du lecteur demandé.

Paramètres facultatifs de la requête

Ces méthodes prennent en charge le paramètre de requête $select pour mettre en forme la réponse.

Réponse

Chacune de ces méthodes renvoie une ressource Drive du lecteur correspondant dans le corps de la réponse.

Codes de réponse d’erreur

Si le lecteur n’existe pas et ne peut pas être approvisionné automatiquement (lors de l’utilisation de l’authentification déléguée), une HTTP 404 réponse est retournée.

Exemples

Exemple 1 : Obtenir un lecteur

Demande

L’exemple suivant illustre une demande.

GET /me/drive

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-type: application/json

{
    "id": "b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7",
    "driveType": "business",
    "owner": {
        "user": {
            "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
            "displayName": "Ryan Gregg"
        }
    },
    "quota": {
        "deleted": 256938,
        "remaining": 1099447353539,
        "state": "normal",
        "total": 1099511627776
    }
}

Exemple 2 : Obtenir un lecteur et ses paramètres

La propriété settings n’est pas renvoyée par défaut. L’exemple suivant sert $select à le demander explicitement dans la réponse.

Demande

L’exemple suivant illustre une demande.

GET /drives/b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7?$select=id,settings

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 200 OK
Content-type: application/json

{
    "id": "b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7",
    "settings": {
        "itemDefaultSensitivityLabelId": "bf7ea563-b848-4ec8-9155-b2054564cfe4"
    }
}