directoryObject: getAvailableExtensionProperties

Namespace: microsoft.graph

Retornar todas as definições de extensão de diretório registradas em um diretório, inclusive por meio de aplicativos multilocatário. As seguintes entidades dão suporte a propriedades de extensão:

Importante

Essa API tem um problema conhecido e só processa resultados para locatários com até 1.000 entidades de serviço; caso contrário, ele retornará uma resposta vazia. Em vez disso, use List extensionProperties (extensões de diretório ).

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Directory.Read.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Directory.Read.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Escritores de diretório
  • Administrador de Aplicativos de Nuvem
  • Administrador de Aplicativos

Solicitação HTTP

POST /directoryObjects/getAvailableExtensionProperties

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON dos parâmetros.

A tabela a seguir mostra os parâmetros que podem ser usados com esta ação.

Parâmetro Tipo Descrição
isSyncedFromOnPremises Booliano true para especificar que somente as propriedades de extensão que são sincronizadas do diretório local devem ser retornadas; false para especificar que somente as propriedades de extensão que não são sincronizadas do diretório local devem ser retornadas. Se o parâmetro for omitido, todas as propriedades da extensão (sincronizadas e não sincronizadas) serão retornadas. Opcional.

Resposta

Se for bem-sucedida, essa ação retornará um código de 200 OK resposta e uma coleção extensionProperty no corpo da resposta.

Exemplos

Solicitação

POST https://graph.microsoft.com/v1.0/directoryObjects/getAvailableExtensionProperties

{

}

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(extensionProperty)",
  "value": [
    {
      "@odata.type": "#microsoft.graph.extensionProperty",
      "id": "d6a8bfec-893d-46e4-88fd-7db5fcc0fa62",
      "deletedDateTime": null,
      "appDisplayName": "SampleApp",
      "name": "extension_4d405aa8baa04fb494d3e0571fd9fd71_skypeId",
      "dataType": "String",
      "isSyncedFromOnPremises": false,
      "targetObjects": [
        "User"
      ]
    }
  ]
}