directoryObject: getByIds

[アーティクル]
04/06/2022

名前空間: microsoft.graph

ID のリストで指定されたディレクトリオブジェクトを返します。

注意

この API には既知の問題があります。返されるすべてのディレクトリオブジェクトが、すべてのプロパティを含む完全なオブジェクトであるとは限りません。

この関数の一般的な用途は次のとおりです。

getMemberObjects または getMemberGroups などの (ID のコレクションを返す) 関数から返された ID を、バッキングディレクトリオブジェクトに解決する。
アプリケーションによって外部記憶装置に保存されている ID をバッキングディレクトリオブジェクトに解決する。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Directory.Read.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Directory.Read.All

アプリケーションが directoryObject 型のコレクションを返す関係をクエリするときに、特定の派生型 (デバイスなど) を読み取るアクセス許可がない場合、その型のメンバーが返されますが、情報は限られます。この動作により、アプリケーションは、Directory.* 権限が付与されたアクセス許可のセットに依存するのではなく、必要な最小限のアクセス許可を要求できます。詳細については、「アクセスできないメンバーオブジェクトについて、限定された情報が返される」を参照してください。

HTTP 要求

POST /directoryObjects/getByIds

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。
Content-type	application/json. Required.

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター	型	説明
ids	String collection	オブジェクトを戻す ID のコレクション。 ID は、文字列として表された GUID です。最大 1000 ID まで指定できます。
types	String コレクション	検索するリソースコレクションの集合を指定するリソースタイプのコレクション。指定しない場合、デフォルトは directoryObject で、ディレクトリで定義されたすべてのリソース・タイプが含まれます。directoryObject から派生したオブジェクトであれば、コレクションに指定することができます。例えば、ユーザー、グループ、およびデバイス・オブジェクトなどです。クラウドソリューションプロバイダーパートナー組織への参照を検索するには、directoryObjectPartnerReference を指定します。指定しない場合、既定値は、ディレクトリで定義されているすべてのリソース型を含む directoryObject になります (クラウドソリューションプロバイダーパートナー組織への参照をのぞく)。値では、大文字と小文字は区別されません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で文字列コレクションオブジェクトを返します。

例

要求

POST https://graph.microsoft.com/v1.0/directoryObjects/getByIds
Content-type: application/json

{
    "ids":["84b80893874940a3-97b7-68513b600544","5d6059b6368d-45f8-91e18e07d485f1d0"],
    "types":["user"]
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var ids = new List<String>()
{
    "84b80893874940a3-97b7-68513b600544",
    "5d6059b6368d-45f8-91e18e07d485f1d0"
};

var types = new List<String>()
{
    "user"
};

await graphClient.DirectoryObjects
    .GetByIds(ids,types)
    .Request()
    .PostAsync();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
    authProvider,
};

const client = Client.init(options);

const directoryObject = {
    ids: ['84b80893874940a3-97b7-68513b600544','5d6059b6368d-45f8-91e18e07d485f1d0'],
    types: ['user']
};

await client.api('/directoryObjects/getByIds')
    .post(directoryObject);

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/directoryObjects/getByIds"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSMutableArray *idsList = [[NSMutableArray alloc] init];
[idsList addObject: @"84b80893874940a3-97b7-68513b600544"];
[idsList addObject: @"5d6059b6368d-45f8-91e18e07d485f1d0"];
payloadDictionary[@"ids"] = idsList;

NSMutableArray *typesList = [[NSMutableArray alloc] init];
[typesList addObject: @"user"];
payloadDictionary[@"types"] = typesList;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<String> idsList = new LinkedList<String>();
idsList.add("84b80893874940a3-97b7-68513b600544");
idsList.add("5d6059b6368d-45f8-91e18e07d485f1d0");

LinkedList<String> typesList = new LinkedList<String>();
typesList.add("user");

graphClient.directoryObjects()
    .getByIds(DirectoryObjectGetByIdsParameterSet
        .newBuilder()
        .withIds(idsList)
        .withTypes(typesList)
        .build())
    .buildRequest()
    .post();

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
requestBody.SetIds( []String {
    "84b80893874940a3-97b7-68513b600544",
    "5d6059b6368d-45f8-91e18e07d485f1d0",
}
requestBody.SetTypes( []String {
    "user",
}
result, err := graphClient.DirectoryObjects().GetByIds().Post(requestBody)

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.DirectoryObjects

$params = @{
    Ids = @(
        "84b80893874940a3-97b7-68513b600544"
        "5d6059b6368d-45f8-91e18e07d485f1d0"
    )
    Types = @(
        "user"
    )
}

Get-MgDirectoryObjectById -BodyParameter $params

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
    "value": [
      {
        "@odata.type": "#microsoft.graph.user",
        "id": "84b80893-8749-40a3-97b7-68513b600544",
        "accountEnabled": true,
        "displayName": "Trevor Jones"
      },
      {
        "@odata.type": "#microsoft.graph.user",
        "id": "84b80893-8749-40a3-97b7-68513b600544",
        "accountEnabled": true,
        "displayName": "Billy Smith"
      }
    ]
}

directoryObject: getByIds

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック