Skip to content

Commit b9ad24c

Browse files
authored
Merge branch 'main' into mgt/chore/update-spfx-docs
2 parents bc6088a + cce9884 commit b9ad24c

File tree

70 files changed

+2260
-70
lines changed

Some content is hidden

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

70 files changed

+2260
-70
lines changed

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

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
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+
<!-- {
62+
"blockType": "request",
63+
"name": "get_certificateauthoritydetail"
64+
}
65+
-->
66+
``` http
67+
GET https://graph.microsoft.com/beta/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
68+
```
69+
70+
71+
### Response
72+
73+
The following example shows the response.
74+
>**Note:** The response object shown here might be shortened for readability.
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true,
78+
"@odata.type": "microsoft.graph.certificateAuthorityDetail"
79+
}
80+
-->
81+
``` http
82+
HTTP/1.1 200 OK
83+
Content-Type: application/json
84+
85+
{
86+
"value": {
87+
"@odata.type": "#microsoft.graph.certificateAuthorityDetail",
88+
"id": "90777c92-2eb3-4a68-931d-4a3e1e1c741f",
89+
"deletedDateTime": null,
90+
"certificateAuthorityType": "root",
91+
"certificate": "Binary",
92+
"displayName": "Contoso2 CA1",
93+
"issuer": "Contoso2",
94+
"issuerSubjectKeyIdentifier": "C0E9....711A",
95+
"createdDateTime": "2024-10-25T18:05:28Z",
96+
"expirationDateTime": "2027-08-29T02:05:57Z",
97+
"thumbprint": "C6FA....4E9CF2",
98+
"certificateRevocationListUrl": null,
99+
"deltacertificateRevocationListUrl": null,
100+
"isIssuerHintEnabled": true
101+
}
102+
}
103+
```
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
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+
<!-- {
75+
"blockType": "request",
76+
"name": "update_certificateauthoritydetail"
77+
}
78+
-->
79+
``` http
80+
PATCH https://graph.microsoft.com/beta/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
81+
Content-Type: application/json
82+
83+
{
84+
85+
"isIssuerHintEnabled": true
86+
87+
}
88+
```
89+
90+
91+
### Response
92+
93+
The following example shows the response.
94+
>**Note:** The response object shown here might be shortened for readability.
95+
<!-- {
96+
"blockType": "response",
97+
"truncated": true,
98+
"@odata.type": "microsoft.graph.certificateAuthorityDetail"
99+
}
100+
-->
101+
``` http
102+
HTTP/1.1 200 OK
103+
Content-Type: application/json
104+
105+
{
106+
"@odata.type": "#microsoft.graph.certificateAuthorityDetail",
107+
"id": "90777c92-2eb3-4a68-931d-4a3e1e1c741f",
108+
"deletedDateTime": null,
109+
"certificateAuthorityType": "root",
110+
"certificate": "Binary",
111+
"displayName": "Contoso2 CA1",
112+
"issuer": "Contoso2",
113+
"issuerSubjectKeyIdentifier": "C0E9....711A",
114+
"createdDateTime": "2024-10-25T18:05:28Z",
115+
"expirationDateTime": "2027-08-29T02:05:57Z",
116+
"thumbprint": "C6FA....4E9CF2",
117+
"certificateRevocationListUrl": null,
118+
"deltacertificateRevocationListUrl": null,
119+
"isIssuerHintEnabled": true
120+
121+
}
122+
```
123+
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
title: "Delete certificateAuthorityDetail"
3+
description: "Delete a certificateAuthorityDetail object."
4+
author: "suawat"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: apiPageType
8+
---
9+
10+
# Delete certificateAuthorityDetail
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Delete 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": "certificatebasedauthpki_delete_certificateauthorities" } -->
23+
[!INCLUDE [permissions-table](../includes/permissions/certificatebasedauthpki-delete-certificateauthorities-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+
``` http
34+
DELETE /directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
35+
```
36+
37+
## Request headers
38+
39+
|Name|Description|
40+
|:---|:---|
41+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
42+
43+
## Request body
44+
45+
Don't supply a request body for this method.
46+
47+
## Response
48+
49+
If successful, this method returns a `204 No Content` response code.
50+
51+
## Examples
52+
53+
### Request
54+
55+
The following example shows a request.
56+
<!-- {
57+
"blockType": "request",
58+
"name": "delete_certificateauthoritydetail"
59+
}
60+
-->
61+
``` http
62+
DELETE https://graph.microsoft.com/beta/directory/publicKeyInfrastructure/certificateBasedAuthConfigurations/{certificateBasedAuthPkiId}/certificateAuthorities/{certificateAuthorityDetailId}
63+
```
64+
65+
66+
### Response
67+
68+
The following example shows the response.
69+
<!-- {
70+
"blockType": "response",
71+
"truncated": true
72+
}
73+
-->
74+
``` http
75+
HTTP/1.1 204 No Content
76+
```
77+

0 commit comments

Comments
 (0)