Skip to content

directoryobject-getavailableextensionproperties.md

Latest commit

 

History

History
147 lines (112 loc) · 5.63 KB

directoryobject-getavailableextensionproperties.md

File metadata and controls

147 lines (112 loc) · 5.63 KB
title directoryObject: getAvailableExtensionProperties
description Get all or a filtered list of the directory extension properties that are registered in a directory.
author dkershaw10
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type apiPageType
ms.date 03/06/2024

directoryObject: getAvailableExtensionProperties

Namespace: microsoft.graph

Return all directory extension definitions that are registered in a directory, including through multitenant apps. The following entities support extension properties:

Important

This API has a known issue and only processes results for tenants with up to 1,000 service principals; otherwise, it returns an empty response. Use List extensionProperties (directory extensions) instead.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-apps-applications-directoryextensions-apis]

HTTP request

POST /directoryObjects/getAvailableExtensionProperties

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description
isSyncedFromOnPremises Boolean true to specify that only extension properties that are synced from the on-premises directory should be returned; false to specify that only extension properties that aren't synced from the on-premises directory should be returned. If the parameter is omitted, all extension properties (both synced and nonsynced) are returned. Optional.

Response

If successful, this action returns a 200 OK response code and an extensionProperty collection in the response body.

Examples

Request

HTTP

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

{

}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

Note: The response object shown here might be shortened for readability.

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