Skip to content

Commit 4d5e435

Browse files
Fixing and updating the docs
1 parent bde7cac commit 4d5e435

File tree

3 files changed

+81
-2
lines changed

3 files changed

+81
-2
lines changed

src/Authentication/docs/AT-Pop.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Microsoft Graph PowerShell SDK: Access Token Proof of Possession (AT PoP) Capability
2+
3+
## Overview
4+
5+
This README provides comprehensive details on the Access Token Proof of Possession (AT PoP) functionality introduced in the Microsoft Graph PowerShell SDK. This feature enhances security by binding tokens to specific HTTP methods and URIs, ensuring they are used only for their intended purposes.
6+
7+
## Table of Contents
8+
9+
- [Key Features](#key-features)
10+
- [Installation](#installation)
11+
- [Configuration](#configuration)
12+
- [Usage Examples](#usage-examples)
13+
- [References](#references)
14+
15+
## Key Features
16+
17+
- **Access Token Proof of Possession (AT PoP)**: This feature binds tokens to specific HTTP methods and URIs, preventing misuse of tokens by ensuring they are used only for the intended HTTP requests.
18+
- **Updated Dependencies**: Compatibility improvements with recent library changes.
19+
- **Enhanced Token Acquisition Options**: Users can now specify the HTTP method and URI during token acquisition to further secure token usage.
20+
21+
### Token acquisition behaviors
22+
23+
| Condition | Unbound (default) | Bound (PoP) |
24+
|-----------|-----------|-----------|
25+
| First sign-in | New token, interactive| New token, interactive |
26+
| Existing token, same URI | No new token, silent | No new token, silent |
27+
| Existing token, different URI | No new token, silent | New token, silent |
28+
| Existing expired token, below max token refreshes | New token, silent | New token, silent |
29+
| Existing expired token, exceeded max refreshes | New token, interactive | New token, interactive |
30+
31+
## Installation
32+
33+
To install the Microsoft Graph PowerShell SDK with the latest updates, use the following command:
34+
35+
```powershell
36+
Install-Module -Name Microsoft.Graph -AllowClobber -Force
37+
```
38+
39+
Ensure you are using the latest version to access the AT PoP functionality.
40+
41+
## Configuration
42+
43+
### Enabling Access Token Proof of Possession
44+
45+
To enable AT PoP, configure the Microsoft Graph SDK options as follows:
46+
47+
```powershell
48+
Set-MgGraphOption -EnableATPoP $true
49+
50+
Connect-MgGraph
51+
```
52+
53+
This configuration ensures that the acquired token is only valid for the specified HTTP method and URI.
54+
55+
## Usage Examples
56+
57+
### Example 1:
58+
59+
```powershell
60+
Set-MgGraphOption -EnableATPoP $true
61+
62+
Connect-MgGraph
63+
64+
Invoke-MgGraphRequest -Method GET https://graph.microsoft.com/v1.0/me -Debug
65+
```
66+
67+
### Example 2:
68+
69+
```powershell
70+
Set-MgGraphOption -EnableATPoP $true
71+
72+
Connect-MgGraph
73+
74+
Invoke-MgGraphRequest -Uri "https://graph.microsoft.com/v1.0/me/sendMail" -Method POST -Debug
75+
```
76+
77+
## References
78+
79+
This README provides a detailed guide on the new AT PoP functionality, offering users the ability to secure their token usage effectively. If you have any questions or need further assistance, please refer to the official [Microsoft Graph PowerShell SDK documentation](https://docs.microsoft.com/en-us/powershell/microsoftgraph/).

src/Authentication/docs/Get-MgGraphOption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.Graph.Authentication.dll-Help.xml
33
Module Name: Microsoft.Graph.Authentication
4-
online version: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mgenvironment
4+
online version: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/get-mggraphoption
55
schema: 2.0.0
66
---
77

src/Authentication/docs/Set-MgGraphOption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.Graph.Authentication.dll-Help.xml
33
Module Name: Microsoft.Graph.Authentication
4-
online version: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mgenvironment
4+
online version: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.authentication/set-mggraphoption
55
schema: 2.0.0
66
---
77

0 commit comments

Comments
 (0)