ユーザーを一覧表示するList users

名前空間: microsoft.graphNamespace: microsoft.graph

user オブジェクトの一覧を取得します。Retrieve a list of user objects.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)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
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication User.Read.All、User.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.AllUser.Read.All, User.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

HTTP 要求HTTP request

GET /users

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports the OData Query Parameters to help customize the response.

既定では、限定的なプロパティのセットのみが返されます (businessPhonesdisplayNamegivenNameidjobTitlemailmobilePhoneofficeLocationpreferredLanguagesurname、および userPrincipalName)。By default, only a limited set of properties are returned (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, and userPrincipalName).

別のプロパティ セットを返すには、OData $select クエリ パラメーターを使用して、目的の user プロパティのセットを指定します。To return an alternative property set, specify the desired set of user properties using the OData $select query parameter. たとえば、displayNamegivenNamepostalCode を返すには、クエリ $select=displayName,givenName,postalCode に次を追加します。For example, to return displayName, givenName, and postalCode, add the following to your query $select=displayName,givenName,postalCode.

特定のプロパティは、ユーザー コレクションでは返すことができません。単一のユーザーを取得する場合にのみ、aboutMebirthdayhireDateinterestsmySitepastProjectspreferredNameresponsibilitiesschoolsskillsmailboxSettings の各プロパティがサポートされます。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.

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization Bearer {トークン} (必須)Bearer {token} (required)

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で user オブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and collection of user objects in the response body. 大きいユーザー コレクションが返された場合は、アプリでページングを使用することができます。If a large user collection is returned, you can use paging in your app.

Examples

例 1:標準的なユーザーの要求Example 1: Standard users request

既定では、限定的なプロパティのセットのみが返されます (businessPhonesdisplayNamegivenNameidjobTitlemailmobilePhoneofficeLocationpreferredLanguagesurnameuserPrincipalName)。By default, only a limited set of properties are returned (businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, userPrincipalName). この例では、既定の要求と応答を示します。This example illustrates the default request and response.

要求Request
GET https://graph.microsoft.com/v1.0/users
応答Response
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"
    }
  ]
}

例 2:$select を使用したユーザーの要求Example 2: Users request using $select

別のプロパティ セットを必要とする場合、OData $select クエリ パラメーターを使用することができます。If you need a different property set, you can use the OData $select query parameter. たとえば、displayNamegivenNamepostalCode を返すには、クエリに $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.

要求Request
GET https://graph.microsoft.com/v1.0/users?$select=displayName,givenName,postalCode
応答Response

注: 簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。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"
    }
  ]
}

例 3: サインイン名を使用してユーザー アカウントを検索するExample 3: Find a user account using a sign-in name

サインイン名 (ローカル アカウントとも呼ばれます) を使用して、B2C テナントでユーザー アカウントを検索します。Find a user account in a B2C tenant, using a sign-in name (also known as a local account). ヘルプデスクはこの要求を使用して、B2C テナント (この例では B2C テナントは contoso.onmicrosoft.com) で顧客のユーザー アカウントを検索できます。This request can be used by a helpdesk to find a customer's user account, in a B2C tenant (in this example the B2C tenant is contoso.onmicrosoft.com).

注意

ID でフィルター処理する場合、issuerissuerAssignedId の両方を指定する必要があります。When filtering on identities, you must supply both issuer and issuerAssignedId.

要求Request

要求の例を次に示します。The following is an example of the request.

GET https://graph.microsoft.com/v1.0/users?$select=displayName,id&$filter=identities/any(c:c/issuerAssignedId eq 'j.smith@yahoo.com' and c/issuer eq 'contoso.onmicrosoft.com')

応答Response

応答の例を次に示します。The following is an example of the response.

注: 読みやすくするために、ここに示す応答オブジェクトは短くされている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

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

{
  "value": [
    {
      "displayName": "John Smith",
      "id": "4c7be08b-361f-41a8-b1ef-1712f7a3dfb2"
    }
  ]
}