Skip to content

Commit 4ee009c

Browse files
authored
Merge branch 'main' into doc-improvement-app-catalog
2 parents fa88881 + a180cab commit 4ee009c

File tree

1,689 files changed

+30328
-4046
lines changed

Some content is hidden

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

1,689 files changed

+30328
-4046
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: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
with:
2424
path: docs
2525

26-
- name: Run PowerShell script
26+
- name: Run PowerShell script to update permissions
2727
shell: pwsh
2828
run: |
2929
$ClientId = "${{ secrets.GRAPH_CLIENT_ID }}"
@@ -38,22 +38,46 @@ jobs:
3838
application-id: ${{ secrets.APPLICATION_ID }}
3939
application-private-key: ${{ secrets.APPLICATION_PRIVATE_KEY }}
4040

41-
- name: Commit updates and open a pull request
41+
- name: Commit updates from service principal
4242
working-directory: ./docs
4343
shell: pwsh
4444
env:
45-
GH_TOKEN: ${{ steps.get_token.outputs.app-token }}
45+
GH_TOKEN: ${{ steps.get_token.outputs.app-token }}
4646
run: |
4747
$status = git status --porcelain
4848
if ($status -eq $null) {
4949
Write-Host "No changes to commit." -ForegroundColor Green
50-
} else {
51-
$timestamp = Get-Date -Format FileDateTimeUniversal
50+
}
51+
else {
5252
git config user.email "GraphTooling@service.microsoft.com"
5353
git config user.name "Microsoft Graph DevX Tooling"
54-
git checkout -b permissions-reference/$timestamp
5554
git add .
5655
git commit -m "Update permissions reference"
57-
git push --set-upstream origin permissions-reference/$timestamp
58-
gh pr create --base main --title "Automated permissons reference update" --body "Scheduled permissions reference update" --reviewer "FaithOmbongi","msewaweru" --label "ready for content review"
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"
5983
}

.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/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

api-reference/beta/api/application-list-owners.md

Lines changed: 37 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: "List owners"
3-
description: "Retrieve a list of owners (directoryObject objects) for an application."
2+
title: "List owners of an application"
3+
description: "Retrieve a list of owners for an application."
44
author: "sureshja"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-applications"
77
doc_type: apiPageType
88
---
99

10-
# List owners
10+
# List owners of an application
1111

1212
Namespace: microsoft.graph
1313

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

16-
Retrieve a list of owners for an application that are [directoryObject](../resources/directoryobject.md) objects.
16+
Retrieve a list of owners for an application that are [directoryObject](../resources/directoryobject.md) types.
1717

1818
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
1919

@@ -25,8 +25,6 @@ Choose the permission or permissions marked as least privileged for this API. Us
2525

2626
[!INCLUDE [limited-info](../../includes/limited-info.md)]
2727

28-
29-
3028
## HTTP request
3129

3230
You can address the application using either its **id** or **appId**. **id** and **appId** are referred to as the **Object ID** and **Application (Client) ID**, respectively, in app registrations in the Microsoft Entra admin center.
@@ -37,7 +35,7 @@ GET /applications(appId='{appId}')/owners
3735
```
3836

3937
## Optional query parameters
40-
This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response.
38+
This method supports the `$count`, `$expand`, `$filter`, `$orderby`, `$search`, `$select`, and `$top` [OData query parameters](/graph/query-parameters) to help customize the response. Some queries are supported only when you use the **ConsistencyLevel** header set to `eventual` and `$count`. For more information, see [Advanced query capabilities on directory objects](/graph/aad-advanced-queries).
4139

4240
## Request headers
4341
| Name | Description |
@@ -51,54 +49,20 @@ Don't supply a request body for this method.
5149

5250
If successful, this method returns a `200 OK` response code and collection of [directoryObject](../resources/directoryobject.md) objects in the response body.
5351
## Example
54-
##### Request
55-
The following example shows a request.
52+
### Request
53+
The following example shows a request that uses the **appId** alternate key to query the owners of an application.
5654

57-
# [HTTP](#tab/http)
5855
<!-- {
5956
"blockType": "request",
6057
"name": "application_get_owners"
6158
}-->
6259
```msgraph-interactive
63-
GET https://graph.microsoft.com/beta/applications/{id}/owners
60+
GET https://graph.microsoft.com/beta/applications(appId='bbec3106-565f-4907-941e-96b4dbfef21c')/owners
6461
```
6562

66-
# [C#](#tab/csharp)
67-
[!INCLUDE [sample-code](../includes/snippets/csharp/application-get-owners-csharp-snippets.md)]
68-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
69-
70-
# [CLI](#tab/cli)
71-
[!INCLUDE [sample-code](../includes/snippets/cli/application-get-owners-cli-snippets.md)]
72-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
73-
74-
# [Go](#tab/go)
75-
[!INCLUDE [sample-code](../includes/snippets/go/application-get-owners-go-snippets.md)]
76-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
77-
78-
# [Java](#tab/java)
79-
[!INCLUDE [sample-code](../includes/snippets/java/application-get-owners-java-snippets.md)]
80-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
81-
82-
# [JavaScript](#tab/javascript)
83-
[!INCLUDE [sample-code](../includes/snippets/javascript/application-get-owners-javascript-snippets.md)]
84-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
85-
86-
# [PHP](#tab/php)
87-
[!INCLUDE [sample-code](../includes/snippets/php/application-get-owners-php-snippets.md)]
88-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
89-
90-
# [PowerShell](#tab/powershell)
91-
[!INCLUDE [sample-code](../includes/snippets/powershell/application-get-owners-powershell-snippets.md)]
92-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
93-
94-
# [Python](#tab/python)
95-
[!INCLUDE [sample-code](../includes/snippets/python/application-get-owners-python-snippets.md)]
96-
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
97-
98-
---
99-
100-
##### Response
101-
The following example shows the response. Note: The response object shown here might be shortened for readability.
63+
### Response
64+
The following example shows the response. It shows only the **id** property as populated while other properties as `null`. This is because the caller did not have permissions to read users in the tenant.
65+
>**Note:** The response object shown here might be shortened for readability.
10266
<!-- {
10367
"blockType": "response",
10468
"truncated": true,
@@ -110,11 +74,32 @@ HTTP/1.1 200 OK
11074
Content-type: application/json
11175
11276
{
113-
"value": [
114-
{
115-
"id": "id-value"
116-
}
117-
]
77+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryObjects",
78+
"@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET applications(appId=<key>)/owners?$select=deletedDateTime",
79+
"value": [
80+
{
81+
"@odata.type": "#microsoft.graph.user",
82+
"id": "ce4770b3-70b2-4a38-a242-76631e9f7408",
83+
"businessPhones": [],
84+
"displayName": null,
85+
"givenName": null,
86+
"jobTitle": null,
87+
"mail": null,
88+
"mobilePhone": null,
89+
"officeLocation": null,
90+
"preferredLanguage": null,
91+
"surname": null,
92+
"userPrincipalName": null
93+
},
94+
{
95+
"@odata.type": "#microsoft.graph.user",
96+
"id": "858a9c90-38b3-4e78-b915-234aece712c4",
97+
},
98+
{
99+
"@odata.type": "#microsoft.graph.user",
100+
"id": "7585d967-f300-43de-b817-7119a6404c5e",
101+
}
102+
]
118103
}
119104
```
120105

api-reference/beta/api/application-post-calls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This API supports the following PSTN scenarios:
3131
+ P2P call between bot and another peer (Teams user, PSTN), bot invites another Teams user.
3232
+ Bot join the scheduled meeting and then invite PSTN.
3333

34-
+ [!INCLUDE [national-cloud-support](../../includes/global-only.md)]
34+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
3535

3636
## Permissions
3737

api-reference/beta/api/application-upsert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Create a new [application](../resources/application.md) object if it doesn't exi
1818
> [!IMPORTANT]
1919
> Using PATCH to set [**passwordCredential**](../resources/passwordcredential.md) is not supported. Use the [addPassword](./application-addpassword.md) and [removePassword](./application-removepassword.md) methods to update the password or secret for an application.
2020
21-
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
21+
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
2222

2323
## Permissions
2424
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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).

0 commit comments

Comments
 (0)