Skip to content

Commit 2bf9f2a

Browse files
sweta-thapliyalsweta-thapliyal
committed
Merge branch 'main' of https://github.com/microsoftgraph/microsoft-graph-docs into sthapliyal/addClientAppIdToAppDef
2 parents 1e71931 + a180cab commit 2bf9f2a

File tree

2,270 files changed

+37258
-7034
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,270 files changed

+37258
-7034
lines changed

‎.gdn/.gdnbaselines

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"hydrated": true,
3+
"properties": {
4+
"helpUri": "https://eng.ms/docs/microsoft-security/security/azure-security/cloudai-security-fundamentals-engineering/security-integration/guardian-wiki/microsoft-guardian/general/baselines",
5+
"hydrationStatus": "This file does not contain identifying data. It is safe to check into your repo. To hydrate this file with identifying data, run `guardian hydrate --help` and follow the guidance."
6+
},
7+
"version": "1.0.0",
8+
"baselines": {
9+
"default": {
10+
"name": "default",
11+
"createdDate": "2024-08-26 12:06:54Z",
12+
"lastUpdatedDate": "2024-08-26 12:06:54Z"
13+
}
14+
},
15+
"results": {
16+
"b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be": {
17+
"signature": "b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be",
18+
"alternativeSignatures": [
19+
"79e125fb7927450b0ebb02d6b3ddb03d7a6a971e21dfdc1c246ba8fd39f0969e"
20+
],
21+
"target": "update-permissions-reference.ps1",
22+
"line": 170,
23+
"memberOf": [
24+
"default"
25+
],
26+
"tool": "psscriptanalyzer",
27+
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
28+
"createdDate": "2024-08-26 12:06:54Z"
29+
}
30+
}
31+
}

‎.gdn/.gdnsuppress

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"hydrated": true,
3+
"properties": {
4+
"helpUri": "https://eng.ms/docs/microsoft-security/security/azure-security/cloudai-security-fundamentals-engineering/security-integration/guardian-wiki/microsoft-guardian/general/suppressions",
5+
"hydrationStatus": "This file does not contain identifying data. It is safe to check into your repo. To hydrate this file with identifying data, run `guardian hydrate --help` and follow the guidance."
6+
},
7+
"version": "1.0.0",
8+
"suppressionSets": {
9+
"default": {
10+
"name": "default",
11+
"createdDate": "2024-08-26 12:06:54Z",
12+
"lastUpdatedDate": "2024-08-26 12:06:54Z"
13+
}
14+
},
15+
"results": {
16+
"b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be": {
17+
"signature": "b3d46ea406a66acd0fa8b1130ec9be5b501ad4a933d98ce70193c68771b6e7be",
18+
"alternativeSignatures": [
19+
"79e125fb7927450b0ebb02d6b3ddb03d7a6a971e21dfdc1c246ba8fd39f0969e"
20+
],
21+
"target": "update-permissions-reference.ps1",
22+
"line": 170,
23+
"memberOf": [
24+
"default"
25+
],
26+
"tool": "psscriptanalyzer",
27+
"ruleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
28+
"createdDate": "2024-08-26 12:06:54Z"
29+
}
30+
}
31+
}

‎.github/workflows/cloud-support.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
run: dotnet build --configuration Release
3838
- name: Install hidi
3939
run: dotnet tool install microsoft.openapi.hidi -g
40-
- name: Create metadata output director
40+
- name: Create metadata output directory
4141
run: |
4242
mkdir openapi
4343
cd openapi
@@ -55,21 +55,22 @@ jobs:
5555
./transforms/csdl/transform.ps1 -xslPath preprocess_csdl.xsl -inputPath ../../schemas/beta-Mooncake.csdl -outputPath ../../transformed_beta-Mooncake.csdl -addInnerErrorDescription $true -removeCapabilityAnnotations $false -csdlVersion v1.0
5656
- name: Transform CSDL with hidi
5757
working-directory: ./metadata
58+
shell: pwsh
5859
env:
5960
SETTINGS: ./conversion-settings/openapi.json
6061
run: |
61-
hidi transform --cs transformed_v1.0-Prod.csdl -o ../openapi/v1.0/Prod.yml --co -f Yaml --sp $SETTINGS
62-
hidi transform --cs transformed_v1.0-Fairfax.csdl -o ../openapi/v1.0/Fairfax.yml --co -f Yaml --sp $SETTINGS
63-
hidi transform --cs transformed_v1.0-Mooncake.csdl -o ../openapi/v1.0/Mooncake.yml --co -f Yaml --sp $SETTINGS
64-
hidi transform --cs transformed_beta-Prod.csdl -o ../openapi/beta/Prod.yml --co -f Yaml --sp $SETTINGS
65-
hidi transform --cs transformed_beta-Fairfax.csdl -o ../openapi/beta/Fairfax.yml --co -f Yaml --sp $SETTINGS
66-
hidi transform --cs transformed_beta-Mooncake.csdl -o ../openapi/beta/Mooncake.yml --co -f Yaml --sp $SETTINGS
62+
hidi transform --cs transformed_v1.0-Prod.csdl -o ../openapi/v1.0/Prod.yml --co -f Yaml --sp $Env:SETTINGS
63+
hidi transform --cs transformed_v1.0-Fairfax.csdl -o ../openapi/v1.0/Fairfax.yml --co -f Yaml --sp $Env:SETTINGS
64+
hidi transform --cs transformed_v1.0-Mooncake.csdl -o ../openapi/v1.0/Mooncake.yml --co -f Yaml --sp $Env:SETTINGS
65+
hidi transform --cs transformed_beta-Prod.csdl -o ../openapi/beta/Prod.yml --co -f Yaml --sp $Env:SETTINGS
66+
hidi transform --cs transformed_beta-Fairfax.csdl -o ../openapi/beta/Fairfax.yml --co -f Yaml --sp $Env:SETTINGS
67+
hidi transform --cs transformed_beta-Mooncake.csdl -o ../openapi/beta/Mooncake.yml --co -f Yaml --sp $Env:SETTINGS
6768
- name: Run cloud support tool
6869
env:
6970
TOOL: ./tool/src/bin/Release/net8.0/CheckCloudSupport
7071
run: |
71-
$TOOL --open-api ./openapi/v1.0 --api-docs ./docs/api-reference/v1.0/api --remove-old-includes
72-
$TOOL --open-api ./openapi/beta --api-docs ./docs/api-reference/beta/api --remove-old-includes
72+
$TOOL --open-api ./openapi/v1.0 --api-docs ./docs/api-reference/v1.0/api --overrides ./docs/api-reference/cloud.api.overrides.json --excludes ./docs/api-reference/cloud.exclusions.json --remove-old-includes
73+
$TOOL --open-api ./openapi/beta --api-docs ./docs/api-reference/beta/api --overrides ./docs/api-reference/cloud.api.overrides.json --excludes ./docs/api-reference/cloud.exclusions.json --remove-old-includes
7374
- name: Get token
7475
id: get_token
7576
uses: microsoftgraph/get-app-token@v1.0.4

‎.github/workflows/permissions-reference-gen.yml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Update permissions reference file
2+
3+
on:
4+
schedule:
5+
- cron: 0 6 * * 1 # Runs every Monday at 6 AM UTC
6+
workflow_dispatch: # Allows manual triggering of the workflow
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
update-permissions-reference:
14+
name: Update permissions reference
15+
runs-on: windows-latest
16+
17+
steps:
18+
- name: Set up Git to handle long paths
19+
run: git config --system core.longpaths true
20+
21+
- name: Checkout microsoft-graph-docs
22+
uses: actions/checkout@v4.1.3
23+
with:
24+
path: docs
25+
26+
- name: Run PowerShell script to update permissions
27+
shell: pwsh
28+
run: |
29+
$ClientId = "${{ secrets.GRAPH_CLIENT_ID }}"
30+
$TenantId = "${{ secrets.GRAPH_TENANT_ID }}"
31+
$ClientSecret = "${{ secrets.GRAPH_CLIENT_SECRET }}"
32+
./docs/update-permissions-reference.ps1 -ClientId $ClientId -TenantId $TenantId -ClientSecret $ClientSecret
33+
34+
- name: Get token
35+
id: get_token
36+
uses: microsoftgraph/get-app-token@v1.0.4
37+
with:
38+
application-id: ${{ secrets.APPLICATION_ID }}
39+
application-private-key: ${{ secrets.APPLICATION_PRIVATE_KEY }}
40+
41+
- name: Commit updates from service principal
42+
working-directory: ./docs
43+
shell: pwsh
44+
env:
45+
GH_TOKEN: ${{ steps.get_token.outputs.app-token }}
46+
run: |
47+
$status = git status --porcelain
48+
if ($status -eq $null) {
49+
Write-Host "No changes to commit." -ForegroundColor Green
50+
}
51+
else {
52+
git config user.email "GraphTooling@service.microsoft.com"
53+
git config user.name "Microsoft Graph DevX Tooling"
54+
git add .
55+
git commit -m "Update permissions reference"
56+
}
57+
58+
- name: Run PowerShell script to correct errors in permissions descriptions
59+
shell: pwsh
60+
run: |
61+
./docs/correct-permissions-reference-errors.ps1
62+
63+
- name: Commit errors correction and open a pull request
64+
working-directory: ./docs
65+
shell: pwsh
66+
env:
67+
GH_TOKEN: ${{ steps.get_token.outputs.app-token }}
68+
run: |
69+
$status = git status --porcelain
70+
if ($status -eq $null) {
71+
Write-Host "No changes to commit." -ForegroundColor Green
72+
} else {
73+
$dateToday = Get-Date -Format 'yyyy-MM-dd'
74+
$branchName = "permissions-reference/$dateToday"
75+
$prTitle = "${dateToday}: Automated permissions reference update"
76+
77+
git add .
78+
git commit -m "Correct errors in permissions reference"
79+
git checkout -b $branchName
80+
git push --set-upstream origin $branchName
81+
82+
gh pr create --base main --title $prTitle --body "Scheduled permissions reference update" --reviewer "FaithOmbongi,msewaweru" --label "ready for content review"
83+
}

‎.vscode/settings.json

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1-
{
2-
"githubPullRequests.ignoredPullRequestBranches": [
3-
"main"
4-
]
1+
{
2+
"githubPullRequests.ignoredPullRequestBranches": [
3+
"main"
4+
],
5+
"json.schemas": [
6+
{
7+
"fileMatch": [
8+
"cloud.api.overrides.json"
9+
],
10+
"url": "https://raw.githubusercontent.com/microsoftgraph/msgraph-cloud-support/main/schema/api.overrides.schema.json"
11+
},
12+
{
13+
"fileMatch": [
14+
"cloud.exclusions.json"
15+
],
16+
"url": "https://raw.githubusercontent.com/microsoftgraph/msgraph-cloud-support/main/schema/cloud.exclusions.schema.json"
17+
}
18+
]
519
}

‎api-reference/beta/api/accesspackageassignmentrequest-resume.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "accessPackageAssignmentRequest: resume"
3-
description: "Resume accessPackageAssignmentRequest objects."
3+
description: "Resume a user's access package request after waiting for a callback from a custom extension."
44
ms.localizationpriority: medium
55
author: "vikama-microsoft"
66
ms.subservice: "entra-id-governance"
@@ -12,7 +12,9 @@ Namespace: microsoft.graph
1212

1313
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1414

15-
In [Microsoft Entra entitlement management](../resources/entitlementmanagement-overview.md), when an access package policy has been enabled to call out a custom extension and the request processing is waiting for the callback from the customer, the customer can initiate a resume action. It is performed on an [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object whose **requestStatus** is in a `WaitingForCallback` state.
15+
Resume a user's access package request after waiting for a callback from a custom extension.
16+
17+
In [Microsoft Entra entitlement management](../resources/entitlementmanagement-overview.md), when an access package policy has been enabled to call out a custom extension and the request processing is waiting for the callback from the customer, the customer can initiate a resume action. It's performed on an [accessPackageAssignmentRequest](../resources/accesspackageassignmentrequest.md) object whose **requestStatus** is in a `WaitingForCallback` state.
1618

1719
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
1820

@@ -22,6 +24,9 @@ Choose the permission or permissions marked as least privileged for this API. Us
2224
<!-- { "blockType": "permissions", "name": "accesspackageassignmentrequest_resume" } -->
2325
[!INCLUDE [permissions-table](../includes/permissions/accesspackageassignmentrequest-resume-permissions.md)]
2426

27+
> [!IMPORTANT]
28+
> App-only access can be authorized *without* granting the `EntitlementManagement.ReadWrite.All` application permission to the caller. Instead, assign the caller an [Entitlement Management role](/entra/id-governance/entitlement-management-delegate), where `Access package assignment manager` is the least privileged role supported for this operation. For more information on how to assign an Entitlement Management role, see [Create unifiedRoleAssignment](../api/rbacapplication-post-roleassignments.md#example-4-create-a-role-assignment-with-access-package-catalog-scope) or [Delegate access governance to access package managers in entitlement management](/entra/id-governance/entitlement-management-delegate-managers#as-a-catalog-owner-delegate-to-an-access-package-manager).
29+
2530
## HTTP request
2631

2732
> [!NOTE]

‎api-reference/beta/api/adminreportsettings-get.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2626
<!-- { "blockType": "permissions", "name": "adminreportsettings_get" } -->
2727
[!INCLUDE [permissions-table](../includes/permissions/adminreportsettings-get-permissions.md)]
2828

29-
> **Note:** For delegated permissions to allow apps to get report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
29+
> **Note:** For delegated permissions to allow apps to get report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
3030
3131
## HTTP request
3232

@@ -36,6 +36,10 @@ Choose the permission or permissions marked as least privileged for this API. Us
3636
GET /admin/reportSettings
3737
```
3838

39+
## Optional query parameters
40+
41+
This method supports the `$select` [OData query parameter](/graph/query-parameters) to help customize the response.
42+
3943
## Request headers
4044

4145
| Name | Description |

‎api-reference/beta/api/adminreportsettings-update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2424
<!-- { "blockType": "permissions", "name": "adminreportsettings_update" } -->
2525
[!INCLUDE [permissions-table](../includes/permissions/adminreportsettings-update-permissions.md)]
2626

27-
> **Note:** For delegated permissions to allow apps to update report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more details, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
27+
> **Note:** For delegated permissions to allow apps to update report settings on behalf of a user, the tenant administrator must have assigned the user the appropriate Microsoft Entra ID limited administrator role. For more information, see [Authorization for APIs to read Microsoft 365 usage reports](/graph/reportroot-authorization).
2828
2929
## HTTP request
3030
<!-- { "blockType": "ignored" } -->
@@ -45,7 +45,7 @@ PATCH /admin/reportSettings
4545

4646
| Property | Type | Description |
4747
| -------------- | -------------- | ------------------------------------------- |
48-
| displayConcealedNames | Boolean | If set to `true`, all reports will conceal user information such as usernames, groups, and sites. If `false`, all reports will show identifiable information. This property represents a setting in the Microsoft 365 admin center. Required. |
48+
| displayConcealedNames | Boolean | If set to `true`, all reports conceal user information such as usernames, groups, and sites. If `false`, all reports show identifiable information. This property represents a setting in the Microsoft 365 admin center. Required. |
4949

5050
## Response
5151

‎api-reference/beta/api/alert-updatealerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ POST /security/alerts/updateAlerts
3636

3737
| Name | Description |
3838
|:--------------|:--------------|
39-
| Authorization | Bearer {code} |
39+
| Authorization | Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
4040

4141
## Request body
4242

‎api-reference/beta/api/appcatalogs-list-teamsapps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "List teamsApp"
33
description: "List apps from the Microsoft Teams app catalog."
4-
author: "nkramer"
4+
author: "MSFTRickyCastaneda"
55
ms.localizationpriority: medium
66
ms.subservice: "teams"
77
doc_type: apiPageType

0 commit comments

Comments
 (0)