Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
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.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Directory.Read.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Directory.Read.All | Not available. |
Important
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.
- Directory Writers
- Cloud Application Administrator
- Application Administrator
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
POST https://graph.microsoft.com/v1.0/directoryObjects/getAvailableExtensionProperties
{
}
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"
]
}
]
}