Skip to content

Commit def61cf

Browse files
halleclottey-msfthalleclottey-msft
authored
Merge branch 'main' into add-external-event-id
2 parents 1ad16fb + e505329 commit def61cf

File tree

218 files changed

+6813
-146
lines changed

Some content is hidden

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

218 files changed

+6813
-146
lines changed

‎api-reference/beta/api/accesspackage-list-accesspackageresourcerolescopes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "List accessPackageResourceRoleScopes"
3-
description: "Retrieve a list of accesspackageresourcerolescope objects."
3+
description: "Retrieve an access package with a list of accessPackageResourceRoleScope objects."
44
ms.localizationpriority: medium
55
author: "markwahl-msft"
66
ms.subservice: "entra-id-governance"

‎api-reference/beta/api/accesspackagecatalog-list-accesspackageresourceroles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "List accessPackageResourceRoles"
3-
description: "Retrieve a list of accessPackageResourceRole objects."
3+
description: "Retrieve a list of accessPackageResourceRole objects of an accessPackageResource in an accessPackageCatalog."
44
ms.localizationpriority: medium
55
author: "markwahl-msft"
66
ms.subservice: "entra-id-governance"
@@ -132,9 +132,9 @@ Content-type: application/json
132132
}
133133
```
134134

135-
### Example 2: Retrieve the roles of a resource for a SharePoint Online site
135+
### Example 2: Retrieve the roles of a resource for a SharePoint site
136136

137-
This is an example of retrieving the roles of a resource, to obtain the **originId** of each role. This would be used after a SharePoint Online site has been added as a resource to the catalog, as the **originId** of a SharePoint site role, the sequence number of the role in the site, is needed to add the role to an access package.
137+
The following example shows how to retrieve the roles of a resource, to obtain the **originId** of each role. This would be used after a SharePoint site has been added as a resource to the catalog, as the **originId** of a SharePoint site role, the sequence number of the role in the site, is needed to add the role to an access package.
138138

139139
#### Request
140140

@@ -188,7 +188,7 @@ GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/ac
188188

189189
#### Response
190190

191-
The following example shows the response. The **displayName** is the same as shown in the SharePoint Online view of a site, and the **originId** is the underlying identifier established by SharePoint Online for the role.
191+
The following example shows the response. The **displayName** is the same as shown in the SharePoint view of a site, and the **originId** is the underlying identifier established by SharePoint for the role.
192192

193193
> **Note:** The response object shown here might be shortened for readability.
194194

‎api-reference/beta/api/accesspackagecatalog-list-accesspackageresources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "List accessPackageResources"
3-
description: "Retrieve a list of accesspackageresource objects."
3+
description: "Retrieve a list of accessPackageResource objects in an accessPackageCatalog."
44
ms.localizationpriority: medium
55
author: "markwahl-msft"
66
ms.subservice: "entra-id-governance"

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Choose the permission or permissions marked as least privileged for this API. Us
2525
<!-- { "blockType": "permissions", "name": "authorizationpolicy_get" } -->
2626
[!INCLUDE [permissions-table](../includes/permissions/authorizationpolicy-get-permissions.md)]
2727

28+
[!INCLUDE [rbac-authorization-policy-apis-read](../includes/rbac-for-apis/rbac-authorization-policy-apis-read.md)]
29+
2830
## HTTP request
2931

3032
<!-- { "blockType": "ignored" } -->

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2525
<!-- { "blockType": "permissions", "name": "authorizationpolicy_update" } -->
2626
[!INCLUDE [permissions-table](../includes/permissions/authorizationpolicy-update-permissions.md)]
2727

28-
For delegated scenarios, the user needs to have the *Privileged Role Administrator* [Microsoft Entra role](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json).
28+
[!INCLUDE [rbac-authorization-policy-apis-update](../includes/rbac-for-apis/rbac-authorization-policy-apis-update.md)]
2929

3030
## HTTP request
3131

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,7 @@ Choose the permission or permissions marked as least privileged for this API. Us
2222
<!-- { "blockType": "permissions", "name": "azureadauthentication_get" } -->
2323
[!INCLUDE [permissions-table](../includes/permissions/azureadauthentication-get-permissions.md)]
2424

25-
For delegated scenarios, the calling user needs to belong to at least one of the following [Microsoft Entra roles](/entra/identity/role-based-access-control/permissions-reference?toc=%2Fgraph%2Ftoc.json):
26-
+ Global Reader
27-
+ Reports Reader
28-
+ Security Administrator
29-
+ Security Operator
30-
+ Security Reader
25+
[!INCLUDE [rbac-entra-health-service-activity-apis](../includes/rbac-for-apis/rbac-entra-health-service-activity-apis.md)]
3126

3227
## HTTP request
3328

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

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: "Get certificateAuthorityDetail"
3+
description: "Read the properties and relationships of a certificateAuthorityDetail object."
4+
author: "suawat"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: apiPageType
8+
---
9+
10+
# Get certificateAuthorityDetail
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Read the properties and relationships of a [certificateAuthorityDetail](../resources/certificateauthoritydetail.md) object.
17+
18+
## Permissions
19+
20+
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).
21+
22+
<!-- { "blockType": "permissions", "name": "certificateauthoritydetail_get" } -->
23+
[!INCLUDE [permissions-table](../includes/permissions/certificateauthoritydetail-get-permissions.md)]
24+
25+
[!INCLUDE [rbac-cert-based-authpkis-apis](../includes/rbac-for-apis/rbac-cert-based-authpkis-apis.md)]
26+
27+
## HTTP request
28+
29+
<!-- {
30+
"blockType": "ignored"
31+
}
32+
-->
33+
34+
``` http
35+
GET /directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
36+
```
37+
38+
## Optional query parameters
39+
40+
This method supports the `$select` OData query parameter to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
41+
42+
## Request headers
43+
44+
|Name|Description|
45+
|:---|:---|
46+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
47+
48+
## Request body
49+
50+
Don't supply a request body for this method.
51+
52+
## Response
53+
54+
If successful, this method returns a `200 OK` response code and a [certificateAuthorityDetail](../resources/certificateauthoritydetail.md) object in the response body.
55+
56+
## Examples
57+
58+
### Request
59+
60+
The following example shows a request.
61+
# [HTTP](#tab/http)
62+
<!-- {
63+
"blockType": "request",
64+
"name": "get_certificateauthoritydetail"
65+
}
66+
-->
67+
``` http
68+
GET https://graph.microsoft.com/beta/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
69+
```
70+
71+
# [C#](#tab/csharp)
72+
[!INCLUDE [sample-code](../includes/snippets/csharp/get-certificateauthoritydetail-csharp-snippets.md)]
73+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
74+
75+
# [CLI](#tab/cli)
76+
[!INCLUDE [sample-code](../includes/snippets/cli/get-certificateauthoritydetail-cli-snippets.md)]
77+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
78+
79+
# [Go](#tab/go)
80+
[!INCLUDE [sample-code](../includes/snippets/go/get-certificateauthoritydetail-go-snippets.md)]
81+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
82+
83+
# [Java](#tab/java)
84+
[!INCLUDE [sample-code](../includes/snippets/java/get-certificateauthoritydetail-java-snippets.md)]
85+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
86+
87+
# [JavaScript](#tab/javascript)
88+
[!INCLUDE [sample-code](../includes/snippets/javascript/get-certificateauthoritydetail-javascript-snippets.md)]
89+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
90+
91+
# [PHP](#tab/php)
92+
[!INCLUDE [sample-code](../includes/snippets/php/get-certificateauthoritydetail-php-snippets.md)]
93+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
94+
95+
# [Python](#tab/python)
96+
[!INCLUDE [sample-code](../includes/snippets/python/get-certificateauthoritydetail-python-snippets.md)]
97+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
98+
99+
---
100+
101+
102+
### Response
103+
104+
The following example shows the response.
105+
>**Note:** The response object shown here might be shortened for readability.
106+
<!-- {
107+
"blockType": "response",
108+
"truncated": true,
109+
"@odata.type": "microsoft.graph.certificateAuthorityDetail"
110+
}
111+
-->
112+
``` http
113+
HTTP/1.1 200 OK
114+
Content-Type: application/json
115+
116+
{
117+
"value": {
118+
"@odata.type": "#microsoft.graph.certificateAuthorityDetail",
119+
"id": "90777c92-2eb3-4a68-931d-4a3e1e1c741f",
120+
"deletedDateTime": null,
121+
"certificateAuthorityType": "root",
122+
"certificate": "Binary",
123+
"displayName": "Contoso2 CA1",
124+
"issuer": "Contoso2",
125+
"issuerSubjectKeyIdentifier": "C0E9....711A",
126+
"createdDateTime": "2024-10-25T18:05:28Z",
127+
"expirationDateTime": "2027-08-29T02:05:57Z",
128+
"thumbprint": "C6FA....4E9CF2",
129+
"certificateRevocationListUrl": null,
130+
"deltacertificateRevocationListUrl": null,
131+
"isIssuerHintEnabled": true
132+
}
133+
}
134+
```

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

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
---
2+
title: "Update certificateAuthorityDetail"
3+
description: "Update the properties of a certificateAuthorityDetail object."
4+
author: "suawat"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: apiPageType
8+
---
9+
10+
# Update certificateAuthorityDetail
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Update the properties of a [certificateAuthorityDetail](../resources/certificateauthoritydetail.md) object.
17+
18+
## Permissions
19+
20+
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).
21+
22+
<!-- { "blockType": "permissions", "name": "certificateauthoritydetail_update" } -->
23+
[!INCLUDE [permissions-table](../includes/permissions/certificateauthoritydetail-update-permissions.md)]
24+
25+
[!INCLUDE [rbac-cert-based-authpkis-apis](../includes/rbac-for-apis/rbac-cert-based-authpkis-apis.md)]
26+
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
``` http
35+
PATCH /directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
36+
```
37+
38+
## Request headers
39+
40+
|Name|Description|
41+
|:---|:---|
42+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
43+
|Content-Type|application/json. Required.|
44+
45+
## Request body
46+
47+
[!INCLUDE [table-intro](../../includes/update-property-table-intro.md)]
48+
49+
|Property|Type|Description|
50+
|:---|:---|:---|
51+
|certificateAuthorityType|certificateAuthorityType|The type of certificate authority. The possible values are: `root`, `intermediate`, `unknownFutureValue`. |
52+
|certificate|Binary|The type of certificate authority. Possible values are: `root`, `intermediate`.|
53+
|displayName|String|The name of the certificate authority. |
54+
|issuer|String|The issuer of the certificate authority. |
55+
|issuerSubjectKeyIdentifier|String|The subject key identifier of certificate authority. |
56+
|createdDateTime|DateTimeOffset|The date and time when the certificate authority was created. |
57+
|expirationDateTime|DateTimeOffset|The date and time when the certificate authority expires. Required.|
58+
|thumbprint|String|The thumbprint of certificate authority certificate. Required.|
59+
|certificateRevocationListUrl|String|The URL to check if the certificate is revoked. |
60+
|deltacertificateRevocationListUrl|String|The URL to check if the certificate is revoked. |
61+
|isIssuerHintEnabled|Boolean|Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is `false`. |
62+
63+
64+
65+
## Response
66+
67+
If successful, this method returns a `200 OK` response code and an updated [certificateAuthorityDetail](../resources/certificateauthoritydetail.md) object in the response body.
68+
69+
## Examples
70+
71+
### Request
72+
73+
The following example shows a request.
74+
# [HTTP](#tab/http)
75+
<!-- {
76+
"blockType": "request",
77+
"name": "update_certificateauthoritydetail"
78+
}
79+
-->
80+
``` http
81+
PATCH https://graph.microsoft.com/beta/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
82+
Content-Type: application/json
83+
84+
{
85+
86+
"isIssuerHintEnabled": true
87+
88+
}
89+
```
90+
91+
# [C#](#tab/csharp)
92+
[!INCLUDE [sample-code](../includes/snippets/csharp/update-certificateauthoritydetail-csharp-snippets.md)]
93+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
94+
95+
# [CLI](#tab/cli)
96+
[!INCLUDE [sample-code](../includes/snippets/cli/update-certificateauthoritydetail-cli-snippets.md)]
97+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
98+
99+
# [Go](#tab/go)
100+
[!INCLUDE [sample-code](../includes/snippets/go/update-certificateauthoritydetail-go-snippets.md)]
101+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
102+
103+
# [Java](#tab/java)
104+
[!INCLUDE [sample-code](../includes/snippets/java/update-certificateauthoritydetail-java-snippets.md)]
105+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
106+
107+
# [JavaScript](#tab/javascript)
108+
[!INCLUDE [sample-code](../includes/snippets/javascript/update-certificateauthoritydetail-javascript-snippets.md)]
109+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
110+
111+
# [PHP](#tab/php)
112+
[!INCLUDE [sample-code](../includes/snippets/php/update-certificateauthoritydetail-php-snippets.md)]
113+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
114+
115+
# [Python](#tab/python)
116+
[!INCLUDE [sample-code](../includes/snippets/python/update-certificateauthoritydetail-python-snippets.md)]
117+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
118+
119+
---
120+
121+
122+
### Response
123+
124+
The following example shows the response.
125+
>**Note:** The response object shown here might be shortened for readability.
126+
<!-- {
127+
"blockType": "response",
128+
"truncated": true,
129+
"@odata.type": "microsoft.graph.certificateAuthorityDetail"
130+
}
131+
-->
132+
``` http
133+
HTTP/1.1 200 OK
134+
Content-Type: application/json
135+
136+
{
137+
"@odata.type": "#microsoft.graph.certificateAuthorityDetail",
138+
"id": "90777c92-2eb3-4a68-931d-4a3e1e1c741f",
139+
"deletedDateTime": null,
140+
"certificateAuthorityType": "root",
141+
"certificate": "Binary",
142+
"displayName": "Contoso2 CA1",
143+
"issuer": "Contoso2",
144+
"issuerSubjectKeyIdentifier": "C0E9....711A",
145+
"createdDateTime": "2024-10-25T18:05:28Z",
146+
"expirationDateTime": "2027-08-29T02:05:57Z",
147+
"thumbprint": "C6FA....4E9CF2",
148+
"certificateRevocationListUrl": null,
149+
"deltacertificateRevocationListUrl": null,
150+
"isIssuerHintEnabled": true
151+
152+
}
153+
```
154+

0 commit comments

Comments
 (0)