Répertorier des utilisateursList users

Récupérer la liste des objets utilisateur.Retrieve a list of user objects.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) User.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.AllUser.ReadBasic.All, User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Non prise en charge.Not supported.
ApplicationApplication User.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.AllUser.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

Requête HTTPHTTP request

GET /users

Paramètres facultatifs de la requêteOptional query parameters

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.This method supports the OData Query Parameters to help customize the response.

Par défaut, seul un ensemble limité de propriétés est renvoyé (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName).By default, only a limited set of properties are returned ( businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName ).

Pour renvoyer un autre jeu de propriétés, vous devez spécifier le jeu souhaité de propriétés user à l’aide du paramètre de requête $select OData.To return an alternative property set, you must specify the desired set of user properties using the OData $select query parameter. Par exemple, pour renvoyer displayName, givenName et postalCode, vous devez ajouter les éléments suivants à votre requête $select=displayName,givenName,postalCode.For example, to return displayName, givenName, and postalCode, you would use the add the following to your query $select=displayName,givenName,postalCode

Remarque : Certaines propriétés ne peuvent pas être renvoyées dans une collection d’utilisateurs. Les propriétés suivantes sont uniquement prises en charge lors de l’extraction d’un seul utilisateur : aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettingsNote: Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user: aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings

En-têtes de demandeRequest headers

En-têteHeader ValeurValue
AuthorizationAuthorization Bearer {token} (requis)Bearer {token} (required)
Content-TypeContent-Type application/jsonapplication/json

Corps de la demandeRequest body

N’indiquez pas le corps de la demande pour cette méthode.Do not supply a request body for this method.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et une collection d’objets user dans le corps de la réponse.If successful, this method returns a 200 OK response code and collection of user objects in the response body.

ExemplesExamples

Exemple 1 : Demande d’utilisateurs standardExample 1: Standard users request

Par défaut, seul un ensemble limité de propriétés est renvoyé (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName).By default, only a limited set of properties are returned (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName). Cet exemple illustre la demande et la réponse par défaut.This example illustrates the default request and response.

DemandeRequest
GET https://graph.microsoft.com/v1.0/users
RéponseResponse
HTTP/1.1 200 OK
Content-type: application/json
Content-length: 608

{
  "value": [
    {
      "businessPhones": [
        "businessPhones-value"
      ],
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "jobTitle": "jobTitle-value",
      "mail": "mail-value",
      "mobilePhone": "mobilePhone-value",
      "officeLocation": "officeLocation-value",
      "preferredLanguage": "preferredLanguage-value",
      "surname": "surname-value",
      "userPrincipalName": "userPrincipalName-value",
      "id": "id-value"
    }
  ]
}

Exemple de code SDKSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var users = await graphClient.Users
    .Request()
    .GetAsync();

Pour plus d’informations sur la façon d' Ajouter le kit de développement logiciel (SDK) à votre projet et de créer une instance authProvider , consultez la documentation SDK .Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Exemple 2 : Demande d’utilisateurs à l’aide de $selectExample 2: Users request using $select

Si vous avez besoin d’un autre jeu de propriétés, vous pouvez utiliser le paramètre de requête $select OData.If you need a different property set, you can use the OData $select query parameter. Par exemple, pour renvoyer displayName, givenName et postalCode, vous devez ajouter les éléments suivants à votre requête $select=displayName,givenName,postalCode.For example, to return displayName, givenName, and postalCode, you would use the add the following to your query $select=displayName,givenName,postalCode

DemandeRequest
GET https://graph.microsoft.com/v1.0/users?$select=displayName,givenName,postalCode
RéponseResponse

Remarque : l’objet de réponse illustré ici peut être tronqué à des fins de concision.Note: The response object shown here may be truncated for brevity.

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

{
  "value": [
    {
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "postalCode": "postalCode-value"
    }
  ]
}

Exemple de code SDKSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var users = await graphClient.Users
    .Request()
    .Select( e => new {
             e.DisplayName,
             e.GivenName,
             e.PostalCode 
             })
    .GetAsync();

Pour plus d’informations sur la façon d' Ajouter le kit de développement logiciel (SDK) à votre projet et de créer une instance authProvider , consultez la documentation SDK .Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.