directoryObject: getByIdsdirectoryObject: getByIds

Namespace: microsoft.graphNamespace: microsoft.graph

Retorne os objetos de diretório especificados em uma lista de IDs.Return the directory objects specified in a list of IDs.

Observação

Essa API tem um problema conhecido.This API has a known issue. Nem todos os objetos de diretório retornados são os objetos completos que contêm todas as propriedades.Not all directory objects returned are the full objects containing all their properties.

Alguns usos comuns dessa função são:Some common uses for this function are to:

  • Resolva as IDs retornadas por funções (que retornam coleções de IDs) como getMemberObjects ou getMemberGroups para seus objetos de diretório de suporte.Resolve IDs returned by functions (that return collections of IDs) such as getMemberObjects or getMemberGroups to their backing directory objects.
  • Resolva IDs que persistem em um repositório externo pelo aplicativo para seus objetos de diretório de suporte.Resolve IDs persisted in an external store by the application to their backing directory objects.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegado (conta corporativa ou de estudante)Delegated (work or school account) Directory.Read.All, Directory.AccessAsUser.AllDirectory.Read.All, Directory.AccessAsUser.All
Delegado (conta pessoal da Microsoft)Delegated (personal Microsoft account) Sem suporte.Not supported.
AplicativoApplication Directory.Read.AllDirectory.Read.All

Quando um aplicativo consulta uma relação que retorna uma coleção de tipo directoryObject, caso não tenha permissão para ler determinado tipo (como dispositivo), os membros desse tipo são retornados, mas com informações limitadas.When an application queries a relationship that returns a directoryObject type collection, if it does not have permission to read a certain derived type (like device), members of that type are returned but with limited information. Com esse comportamento, os aplicativos podem solicitar as permissões menos privilegiadas de que precisam, em vez de confiar no conjunto de permissões Diretórios.*With this behaviour applications can request the least privileged permissions they need, rather than rely on the set of Directory.* permissions. Para obter mais detalhes, confira Informações limitadas retornadas para objetos membro inacessíveis.For details, see Limited information returned for inaccessible member objects.

Solicitação HTTPHTTP request

POST /directoryObjects/getByIds

Cabeçalhos de solicitaçãoRequest headers

NomeName TipoType DescriçãoDescription
AutorizaçãoAuthorization stringstring {token} de portador. Obrigatório.Bearer {token}. Required.
Content-typeContent-type stringstring application/json. Obrigatório.application/json. Required.

Corpo da solicitaçãoRequest body

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.In the request body, provide a JSON object with the following parameters.

ParâmetroParameter TipoType DescriçãoDescription
idsids Coleção de cadeias de caracteresString collection Uma coleção de IDs para a qual retornar objetos.A collection of IDs for which to return objects. As IDs são GUIDs, representadas como cadeias de caracteres.The IDs are GUIDs, represented as strings. Você pode especificar até 1000 IDs.You can specify up to 1000 IDs.
tipostypes Coleção de cadeias de caracteresString collection Uma coleção de tipos de recursos que especifica o conjunto de coleções de recursos para pesquisar.A collection of resource types that specifies the set of resource collections to search. Se não estiver especificado, o padrão será directoryObject, que contém todos os tipos de recursos definidos no diretório.If not specified, the default is directoryObject, which contains all of the resource types defined in the directory. Qualquer objeto deriva do directoryObject pode ser especificado na coleção. Por exemplo: usuário, grupo, dispositivo e assim por diante.Any object that derives from directoryObject may be specified in the collection; for example: user, group, device, and so on. Para procurar referências para uma organização parceira do Provedor de soluções de nuvem especifique directoryObjectPartnerReference.To search for references to a Cloud Solution Provider partner organization specify directoryObjectPartnerReference. Se não for especificado, o padrão é directoryObject, que contém todos os tipos de recursos definidos no diretório, exceto referências a uma organização parceira do Provedor de soluções de nuvem.If not specified, the default is directoryObject, which contains all of the resource types defined in the directory, except for references to a Cloud Solution Provider partner organization. Os valores não diferenciam maiúsculas de minúsculas.The values are not case sensitive.

RespostaResponse

Se bem-sucedido, este método retorna um código de resposta 200 OK e um objeto da coleção de cadeias de caracteres no corpo da resposta.If successful, this method returns a 200 OK response code and a string collection object in the response body.

ExemploExample

SolicitaçãoRequest

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

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

RespostaResponse

**Observação: **o objeto response mostrado aqui pode ser encurtado para legibilidade. Todas as propriedades serão retornadas de uma chamada real.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

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