Skip to content

Feature/permissions docs #6973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Feature/permissions docs #6973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f96a8f
Added minimal permissions to Entra enterpriseapp commands
santhosh-7777 Oct 2, 2025
3bdfce5
Fix: updated resource names to Microsoft Graph, corrected permissions…
santhosh-7777 Oct 3, 2025
253ac57
docs: add minimal permissions sections for m365 entra user commands
santhosh-7777 Oct 8, 2025
ba61740
standardize permissions table formatting across all entra user commands
santhosh-7777 Oct 9, 2025
691ff29
Fix permissions tables alignment for all m365 entra user commands
santhosh-7777 Oct 10, 2025
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
14 changes: 14 additions & 0 deletions docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,20 @@ Creates an enterprise application for a registered Entra app with the specified
m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
```

## Permissions
<Tabs>
<TabItem value="Delegated">
| Resource | Permissions |
|-----------------|---------------------------|
| Microsoft Graph | Application.ReadWrite.All |
</TabItem>
<TabItem value="Application">
| Resource | Permissions |
|-----------------|---------------------------|
| Microsoft Graph | Application.ReadWrite.All |
</TabItem>
</Tabs>

## Response

<Tabs>
Expand Down
15 changes: 15 additions & 0 deletions docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,21 @@ Return details about the enterprise application with the specified ObjectId.
m365 entra enterpriseapp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
```

## Permissions

<Tabs>
<TabItem value="Delegated">
| Resource | Permissions |
|-----------------|----------------------|
| Microsoft Graph | Application.Read.All |
</TabItem>
<TabItem value="Application">
| Resource | Permissions |
|-----------------|----------------------|
| Microsoft Graph | Application.Read.All |
</TabItem>
</Tabs>

## Response

<Tabs>
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,20 @@ Returns a list of all enterprise applications that comply with the specified dis
m365 entra enterpriseapp list --displayName "My custom enterprise application" --tag "WindowsAzureActiveDirectoryIntegratedApp"
```

## Permissions
<Tabs>
<TabItem value="Delegated">
| Resource | Permissions |
|-----------------|----------------------|
| Microsoft Graph | Application.Read.All |
</TabItem>
<TabItem value="Application">
| Resource | Permissions |
|-----------------|----------------------|
| Microsoft Graph | Application.Read.All |
</TabItem>
</Tabs>

## Response

<Tabs>
Expand Down
14 changes: 14 additions & 0 deletions docs/docs/cmd/entra/enterpriseapp/enterpriseapp-remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,20 @@ Delete an enterprise application by object ID.
m365 entra enterpriseapp remove --objectId b2307a39-e878-458b-bc90-03bc578531dd
```

## Permissions
<Tabs>
<TabItem value="Delegated">
| Resource | Permissions |
|-----------------|---------------------------|
| Microsoft Graph | Application.ReadWrite.All |
</TabItem>
<TabItem value="Application">
| Resource | Permissions |
|-----------------|---------------------------|
| Microsoft Graph | Application.ReadWrite.All |
</TabItem>
</Tabs>

## Response

The command won't return a response on success.
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/cmd/entra/user/user-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,15 @@ This command allows using unknown options. For a comprehensive list of user prop

If the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.

### Permissions

The following permissions are required to run this command:

| Permission Type | Permission | Description |
|--------------------------------- |-------------------- |-----------------------------------|
| Delegated (work or school account)| User.ReadWrite.All | Allows creating and updating users |
| Application | User.ReadWrite.All | Allows creating and updating users |

## Examples

Create a user and let him/her update the password at first login.
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/cmd/entra/user/user-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ You can retrieve information about a user, either by specifying that user's id,

If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.

### Permissions

The following permissions are required to run this command:

| Permission Type | Permission(s) | Description |
|---------------------------------- |----------------|-------------------------------- |
| Delegated (work or school account)| User.Read.All | Allows reading user information |
| Application | User.Read.All | Allows reading user information |

## Examples

Get information about the user by id.
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/cmd/entra/user/user-hibp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ If the user with the specified user name doesn't involved in any breach, you wil

If `API Key` is invalid, you will get a `Required option apiKey not specified` error.

### Permissions

The following permissions are required to run this command.

This command uses the Have I Been Pwned API. It does not call Microsoft Graph and therefore does not require Microsoft Graph permissions. It requires an API key for the Have I Been Pwned service (see `--apiKey`).

## Examples

Check if user with by a user name is in a data breach.
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/cmd/entra/user/user-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ To filter the list of users, include additional options that match the user prop

Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user using: `aboutMe`, `birthday`, `hireDate`, `interests`, `mySite`, `pastProjects`, `preferredName`, `responsibilities`, `schools`, `skills`, `mailboxSettings`.

### Permissions

The following permissions are required to run this command:

| Permission Type | Permission(s) | Description |
|---------------------------------- |---------------------------------- |---------------------------------------------|
| Delegated (work or school account)| Directory.Read.All, User.Read.All | Allows reading directory data and user info |
| Application | User.Read.All | Allows reading user info |

## Examples

List all users in the tenant.
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/cmd/entra/user/user-remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ After running this command, it may take a minute before the user is effectively

:::

### Permissions

The following permissions are required to run this command:

| Permission Type | Permission(s) | Description |
|---------------------------------- |------------------------|----------------------------------- |
| Delegated (work or school account)| User.ReadWrite.All | Allows creating and updating users |
| Application | User.ReadWrite.All | Allows creating and updating users |

## Examples

Removes a specific user by id.
Expand Down
9 changes: 9 additions & 0 deletions docs/docs/cmd/entra/user/user-set.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,15 @@ This command allows using unknown options. For a comprehensive list of user prop

If the user with the specified ID or username doesn't exist, or if the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.

### Permissions

The following permissions are required to run this command:

| Permission Type | Permission(s) | Description |
|---------------------------------- |--------------------------------------- |------------------------------------------------------- |
| Delegated (work or school account)| User.ReadWrite.All, Directory.Read.All | Allows creating/updating users and reading directory data |
| Application | User.ReadWrite.All | Allows creating and updating users |

## Examples

Update specific property _department_ of user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
Expand Down