directoryObject: getAvailableExtensionProperties

Пространство имен: microsoft.graph

Возвращает все определения расширений каталога, зарегистрированные в каталоге, в том числе через мультитенантные приложения. Следующие сущности поддерживают свойства расширения:

• user
• group
• administrativeUnit
• application
• device
• organization

Важно!

Этот API имеет известную проблему и обрабатывает результаты только для клиентов с до 1000 субъектов-служб; В противном случае возвращается пустой ответ. Вместо этого используйте list extensionProperties (расширения каталогов).

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	Directory.Read.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Для приложений	Directory.Read.All	Недоступно.

Важно!

Для делегированного доступа с использованием рабочих или учебных учетных записей пользователю, выполнившего вход, необходимо назначить поддерживаемую роль Microsoft Entra или пользовательскую роль, которая предоставляет разрешения, необходимые для этой операции. Эта операция поддерживает следующие встроенные роли, которые предоставляют только минимальные необходимые привилегии:

• Запись каталогов
• Администратор облачных приложений
• Администратор приложений

HTTP-запрос

POST /directoryObjects/getAvailableExtensionProperties

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

В тело запроса добавьте параметры в формате JSON.

В следующей таблице указаны параметры, которые можно использовать с этим действием.

Параметр	Тип	Описание
isSyncedFromOnPremises	Логический	true , чтобы указать, что должны возвращаться только свойства расширения, синхронизированные из локального каталога; false значение , чтобы указать, что должны возвращаться только свойства расширения, которые не синхронизированы из локального каталога. Если параметр опущен, возвращаются все свойства расширения (синхронизированные и несинхронизированные). Необязательный параметр.

Отклик

В случае успешного выполнения это действие возвращает код отклика 200 OK и коллекцию extensionProperty в тексте ответа.

Примеры

Запрос

HTTP

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

{

}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.DirectoryObjects.GetAvailableExtensionProperties;

var requestBody = new GetAvailableExtensionPropertiesPostRequestBody
{
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DirectoryObjects.GetAvailableExtensionProperties.PostAsGetAvailableExtensionPropertiesPostResponseAsync(requestBody);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdirectoryobjects "github.com/microsoftgraph/msgraph-sdk-go/directoryobjects"
	  //other-imports
)

requestBody := graphdirectoryobjects.NewGetAvailableExtensionPropertiesPostRequestBody()

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
getAvailableExtensionProperties, err := graphClient.DirectoryObjects().GetAvailableExtensionProperties().PostAsGetAvailableExtensionPropertiesPostResponse(context.Background(), requestBody, nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.directoryobjects.getavailableextensionproperties.GetAvailableExtensionPropertiesPostRequestBody getAvailableExtensionPropertiesPostRequestBody = new com.microsoft.graph.directoryobjects.getavailableextensionproperties.GetAvailableExtensionPropertiesPostRequestBody();
var result = graphClient.directoryObjects().getAvailableExtensionProperties().post(getAvailableExtensionPropertiesPostRequestBody);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const extensionProperty = {

};

await client.api('/directoryObjects/getAvailableExtensionProperties')
	.post(extensionProperty);

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\DirectoryObjects\GetAvailableExtensionProperties\GetAvailableExtensionPropertiesPostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new GetAvailableExtensionPropertiesPostRequestBody();

$result = $graphServiceClient->directoryObjects()->getAvailableExtensionProperties()->post($requestBody)->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.DirectoryObjects

$params = @{
}

Get-MgDirectoryObjectAvailableExtensionProperty -BodyParameter $params

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.directoryobjects.get_available_extension_properties.get_available_extension_properties_post_request_body import GetAvailableExtensionPropertiesPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = GetAvailableExtensionPropertiesPostRequestBody(
)

result = await graph_client.directory_objects.get_available_extension_properties.post(request_body)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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