列出用户

检索用户对象列表。

先决条件

要执行此 API,需要以下范围之一:User.ReadBasic.All;User.Read.All;User.ReadWrite.All;Directory.Read.All;Directory.ReadWrite.All;Directory.AccessAsUser.All

HTTP 请求

GET /users

可选的查询参数

此方法支持 OData 查询参数 来帮助自定义响应。

默认情况下,仅返回一组有限的属性(_businessPhones、displayName、givenName、id、jobTitle、mail、mobilePhone、officeLocation、preferredLanguage、surname、userPrincipalName_

若要返回其他属性,必须使用 ODATA $select 查询参数指定所需的一组 user 属性。例如,若要返回 displayName、_givenName、_idpostalCode,则需要将以下项添加到查询 $select=displayName,givenName,postalCode

注意:某些属性无法在用户集合中返回。以下属性仅在检索单个用户 时受支持:_aboutMe、birthday、hireDate、interests、mySite、pastProjects、preferredName、responsibilities、schools、skills、mailboxSettings_

请求标头

标头
Authorization Bearer {token}(必需)
Content-Type application/json

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 user 对象集合。

示例

请求

下面是一个请求示例。

GET https://graph.microsoft.com/v1.0/users
响应

下面是一个响应示例。注意:为了简单起见,可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。

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"
    }
  ]
}