Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 135 additions & 0 deletions docs/docs/cmd/graph/directoryextension/directoryextension-list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
import Global from '/docs/cmd/_global.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# graph directoryextension list

Retrieves a list of directory extensions

## Usage

```sh
m365 graph directoryextension list [options]
```

## Options

```md definition-list
`--appId [appId]`
: Application (client) ID of the Entra application where the directory extensions are registered. Specify either `appId`, `appObjectId` or `appName`, but not multiple.

`--appObjectId [appObjectId]`
: Object ID of the Entra application where the directory extensions are registered. Specify either `appId`, `appObjectId` or `appName`, but not multiple.

`--appName [appName]`
: The name of Entra application where the directory extensions are registered. Specify either `appId`, `appObjectId` or `appName`, but not multiple.
```

<Global />

## Remarks

When neither `appId`, `appObjectId` nor `appName` is specified, the command will return all available directory extensions including those registered for multi-tenant apps.

https://learn.microsoft.com/en-us/graph/api/directoryobject-getavailableextensionproperties?view=graph-rest-1.0&tabs=http

Otherwise, it will return directory extensions for a specific application.

https://learn.microsoft.com/en-us/graph/api/application-list-extensionproperty?view=graph-rest-1.0&tabs=http

## Examples

Get all available directory extensions including those registered for multi-tenant apps

```sh
m365 graph directoryextension list
```

Get all directory extensions registered for an application specified by app id.

```sh
m365 graph directoryextension list --appId fd918e4b-c821-4efb-b50a-5eddd23afc6f
```

Get all directory extensions registered for an application specified by app object id.

```sh
m365 graph directoryextension list --appObjectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844
```

Get all directory extensions registered for an application specified by name.

```sh
m365 graph directoryextension list --appName ContosoApp
```

## Response

<Tabs>
<TabItem value="JSON">

```json
[
{
"id": "8133c498-ad76-4a7b-90a0-675bf5adf492",
"deletedDateTime": null,
"appDisplayName": "ContosoApp",
"dataType": "String",
"isMultiValued": true,
"isSyncedFromOnPremises": false,
"name": "extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup",
"targetObjects": [
"User"
]
}
]
```

</TabItem>
<TabItem value="Text">

```text
appDisplayName : ContosoApp
dataType : String
deletedDateTime : null
id : 8133c498-ad76-4a7b-90a0-675bf5adf492
isMultiValued : true
isSyncedFromOnPremises: false
name : extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup
targetObjects : ["User"]
```

</TabItem>
<TabItem value="CSV">

```csv
id,deletedDateTime,appDisplayName,dataType,isMultiValued,isSyncedFromOnPremises,name
8133c498-ad76-4a7b-90a0-675bf5adf492,,ContosoApp,String,1,0,extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup
```

</TabItem>
<TabItem value="Markdown">

```md
# graph directoryextension list --debug "false" --verbose "false" --appId "66eac1c5-0538-4aec-9e02-4b9e60f5e4b9"

Date: 3/23/2025

## extension_66eac1c505384aec9e024b9e60f5e4b9_jobGroup (8133c498-ad76-4a7b-90a0-675bf5adf492)

Property | Value
---------|-------
id | 8133c498-ad76-4a7b-90a0-675bf5adf492
appDisplayName | ContosoApp
dataType | String
isMultiValued | true
isSyncedFromOnPremises | false
name | extension\_66eac1c505384aec9e024b9e60f5e4b9\_jobGroup
```

</TabItem>
</Tabs>

## More information

- Directory extensions: https://learn.microsoft.com/graph/extensibility-overview#directory-microsoft-entra-id-extensions
5 changes: 5 additions & 0 deletions docs/src/config/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1106,6 +1106,11 @@ const sidebars: SidebarsConfig = {
label: 'directoryextension get',
id: 'cmd/graph/directoryextension/directoryextension-get'
},
{
type: 'doc',
label: 'directoryextension list',
id: 'cmd/graph/directoryextension/directoryextension-list'
},
{
type: 'doc',
label: 'directoryextension remove',
Expand Down
1 change: 1 addition & 0 deletions src/m365/graph/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export default {
CHANGELOG_LIST: `${prefix} changelog list`,
DIRECTORYEXTENSION_ADD: `${prefix} directoryextension add`,
DIRECTORYEXTENSION_GET: `${prefix} directoryextension get`,
DIRECTORYEXTENSION_LIST: `${prefix} directoryextension list`,
DIRECTORYEXTENSION_REMOVE: `${prefix} directoryextension remove`,
OPENEXTENSION_ADD: `${prefix} openextension add`,
OPENEXTENSION_GET: `${prefix} openextension get`,
Expand Down
Loading