Skip to content

Commit 2f9fc0e

Browse files
DanielabomDanielabom
authored
Merge pull request #26062 from microsoftgraph/main
Merge to publish.
2 parents d5af308 + 46cd811 commit 2f9fc0e

File tree

47 files changed

+1135
-98
lines changed

Some content is hidden

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

47 files changed

+1135
-98
lines changed

‎api-reference/beta/api/customauthenticationextension-delete.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "soneff"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: apiPageType
8-
ms.date: 10/16/2024
8+
ms.date: 12/10/2024
99
---
1010

1111
# Delete customAuthenticationExtension
@@ -18,6 +18,7 @@ Delete a [customAuthenticationExtension](../resources/customauthenticationextens
1818
- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type.
1919
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type.
2020
- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
21+
- [onOtpSendCustomExtension](../resources/onOtpSendCustomExtension.md) resource type.
2122

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

@@ -108,5 +109,4 @@ The following example shows the response.
108109
-->
109110
``` http
110111
HTTP/1.1 204 No Content
111-
```
112-
112+
```

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "soneff"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: apiPageType
8-
ms.date: 10/16/2024
8+
ms.date: 12/10/2024
99
---
1010

1111
# Get customAuthenticationExtension
@@ -18,6 +18,7 @@ Read the properties and relationships of a [customAuthenticationExtension](../re
1818
- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type.
1919
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type.
2020
- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
21+
- [onOtpSendCustomExtension](../resources/onOtpSendCustomExtension.md) resource type.
2122

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

@@ -140,5 +141,4 @@ Content-Type: application/json
140141
}
141142
]
142143
}
143-
```
144-
144+
```

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "soneff"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: apiPageType
8-
ms.date: 10/16/2024
8+
ms.date: 12/10/2024
99
---
1010

1111
# Update customAuthenticationExtension
@@ -18,6 +18,7 @@ Update the properties of a [customAuthenticationExtension](../resources/customau
1818
- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type.
1919
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type.
2020
- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
21+
- [onOtpSendCustomExtension](../resources/onOtpSendCustomExtension.md) resource type.
2122

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

@@ -57,7 +58,10 @@ You must specify the `@odata.type` property when updating a [customAuthenticatio
5758
|displayName|String|Display name for the custom extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
5859
|handler|[onAttributeCollectionStartCustomExtensionHandler](../resources/onattributecollectionstartcustomextensionhandler.md)|The handler to invoke when conditions are met. Can be updated for the **onAttributeCollectionStartCustomExtensionListener** listener type.|
5960
|handler|[onAttributeCollectionSubmitCustomExtensionHandler](../resources/onattributecollectionsubmitcustomextensionhandler.md)|The handler to invoke when conditions are met. Can be updated for the **onAttributeCollectionSubmitCustomExtensionListener** listener type.|
61+
|handler|[onOtpSendCustomExtensionHandler](../resources/onOtpSendCustomExtensionHandler.md)|The handler to invoke when conditions are met. Can be updated for the **onOtpSendCustomExtensionListener** listener type.|
6062
|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Configuration for the API endpoint that the custom extension will call. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
63+
|behaviorOnError|[customExtensionBehaviorOnError](../resources/customextensionbehavioronerror.md)|Let to configure behavior if the call to custom authentication extension returns error. Optional.|
64+
6165

6266

6367
## Response
@@ -145,5 +149,4 @@ The following example shows the response.
145149
-->
146150
``` http
147151
HTTP/1.1 204 No Content
148-
```
149-
152+
```

‎api-reference/beta/api/customauthenticationextension-validateauthenticationconfiguration.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "soneff"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: apiPageType
8-
ms.date: 10/16/2024
8+
ms.date: 12/10/2024
99
---
1010

1111
# customAuthenticationExtension: validateAuthenticationConfiguration
@@ -18,6 +18,7 @@ An API to check validity of the endpoint and and authentication configuration fo
1818
- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type.
1919
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type.
2020
- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
21+
- [onOtpSendCustomExtension](../resources/onOtpSendCustomExtension.md) resource type.
2122

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

@@ -220,6 +221,4 @@ Content-Type: application/json
220221
},
221222
]
222223
}
223-
```
224-
225-
224+
```

‎api-reference/beta/api/identitycontainer-list-customauthenticationextensions.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: "soneff"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: apiPageType
8-
ms.date: 10/16/2024
8+
ms.date: 12/09/2024
99
---
1010

1111
# List customAuthenticationExtensions
@@ -18,13 +18,19 @@ Get a list of the [customAuthenticationExtension](../resources/customauthenticat
1818
- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type.
1919
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type.
2020
- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
21+
- [onOtpSendCustomExtension](../resources/onOtpSendCustomExtension.md) resource type.
2122

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

2425
## Permissions
26+
2527
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).
2628

27-
<!-- { "blockType": "permissions", "name": "identitycontainer_list_customauthenticationextensions" } -->
29+
<!-- {
30+
"blockType": "permissions",
31+
"name": "identitycontainer-list-customauthenticationextensions-permissions"
32+
}
33+
-->
2834
[!INCLUDE [permissions-table](../includes/permissions/identitycontainer-list-customauthenticationextensions-permissions.md)]
2935

3036
[!INCLUDE [rbac-custom-auth-ext-apis-read](../includes/rbac-for-apis/rbac-custom-auth-ext-apis-read.md)]
@@ -144,5 +150,4 @@ Content-Type: application/json
144150
}
145151
]
146152
}
147-
```
148-
153+
```

‎api-reference/beta/api/identitycontainer-post-customauthenticationextensions.md

Lines changed: 88 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ author: "soneff"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: apiPageType
8-
ms.date: 10/16/2024
8+
ms.date: 01/09/2024
99
---
1010

1111
# Create customAuthenticationExtension
12+
1213
Namespace: microsoft.graph
1314

1415
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
@@ -18,6 +19,7 @@ Create a new [customAuthenticationExtension](../resources/customauthenticationex
1819
- [onTokenIssuanceStartCustomExtension](../resources/ontokenissuancestartcustomextension.md) resource type.
1920
- [onAttributeCollectionStartCustomExtension](../resources/onattributecollectionstartcustomextension.md) resource type.
2021
- [onAttributeCollectionSubmitCustomExtension](../resources/onattributecollectionsubmitcustomextension.md) resource type.
22+
- [onOtpSendCustomExtension](../resources/onOtpSendCustomExtension.md) resource type.
2123

2224
> [!NOTE]
2325
>
@@ -26,9 +28,14 @@ Create a new [customAuthenticationExtension](../resources/customauthenticationex
2628
[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)]
2729

2830
## Permissions
31+
2932
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).
3033

31-
<!-- { "blockType": "permissions", "name": "identitycontainer_post_customauthenticationextensions" } -->
34+
<!-- {
35+
"blockType": "permissions",
36+
"name": "identitycontainer-post-customauthenticationextensions-permissions"
37+
}
38+
-->
3239
[!INCLUDE [permissions-table](../includes/permissions/identitycontainer-post-customauthenticationextensions-permissions.md)]
3340

3441
[!INCLUDE [rbac-custom-auth-ext-apis-write](../includes/rbac-for-apis/rbac-custom-auth-ext-apis-write.md)]
@@ -44,23 +51,27 @@ POST /identity/customAuthenticationExtensions
4451
```
4552

4653
## Request headers
54+
4755
|Name|Description|
4856
|:---|:---|
4957
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
5058
|Content-Type|application/json. Required.|
5159

5260
## Request body
61+
5362
In the request body, supply a JSON representation of the [customAuthenticationExtension](../resources/customauthenticationextension.md) object.
5463

5564
You can specify the following properties when creating a **customAuthenticationExtension**. You must specify the **@odata.type** property with a value of the customAuthenticationExtension object type that you want to create. For example, to create an **onTokenIssuanceStartCustomExtension** object, set **@odata.type** to `#microsoft.graph.onTokenIssuanceStartCustomExtension`.
5665

5766
|Property|Type|Description|
5867
|:---|:---|:---|
59-
|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for this custom extension. Optional.|
68+
|authenticationConfiguration|[customExtensionAuthenticationConfiguration](../resources/customextensionauthenticationconfiguration.md)|The authentication configuration for this custom extension. Required.|
69+
|behaviorOnError|[customExtensionBehaviorOnError](../resources/customextensionbehavioronerror.md)|Let to configure behavior if the call to custom authentication extension returns error. Optional.|
6070
|clientConfiguration|[customExtensionClientConfiguration](../resources/customextensionclientconfiguration.md)|The connection settings for the custom extension. Optional.|
61-
|description|String|Description for the custom extension. Optional.|
62-
|displayName|String|Display name for the custom extension. Optional.|
63-
|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Configuration for the API endpoint that the custom extension will call. Optional.|
71+
|description|String|Description for the custom extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
72+
|displayName|String|Display name for the custom extension. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
73+
|endpointConfiguration|[customExtensionEndpointConfiguration](../resources/customextensionendpointconfiguration.md)|Configuration for the API endpoint that the custom extension will call. Inherited from [customCalloutExtension](../resources/customcalloutextension.md). Optional.|
74+
6475

6576

6677
## Response
@@ -398,3 +409,74 @@ Content-Type: application/json
398409
}
399410
}
400411
```
412+
### Example 4: Create an onOtpSendCustomExtension object
413+
414+
#### Request
415+
416+
The following example shows a request.
417+
418+
<!-- {
419+
"blockType": "request",
420+
"name": "create_customauthenticationextension_onOtpSendCustomExtension"
421+
}
422+
-->
423+
``` http
424+
POST https://graph.microsoft.com/beta/identity/customAuthenticationExtensions
425+
Content-Type: application/json
426+
427+
{
428+
"@odata.type": "#microsoft.graph.onOtpSendCustomExtension",
429+
"authenticationConfiguration": {
430+
"@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
431+
"resourceId": "api://onotpsendcustomextension.b2c.expert/fb96de85-2abe-4b02-b45f-64ba122c509e"
432+
},
433+
"clientConfiguration": {
434+
"timeoutInMilliseconds": 2000,
435+
"maximumRetries": 1
436+
},
437+
"description": "Use an external Email provider to send OTP Codes.",
438+
"displayName": "onEmailOtpSendCustomExtension",
439+
"endpointConfiguration": {
440+
"@odata.type": "#microsoft.graph.httpRequestEndpoint",
441+
"targetUrl": "https://onotpsendcustomextension.b2c.expert/api/OnOTPCodeSendToTeamsDemo"
442+
},
443+
"behaviorOnError": {
444+
"@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
445+
}
446+
}
447+
```
448+
#### Response
449+
450+
The following example shows the response.
451+
>**Note:** The response object shown here might be shortened for readability.
452+
<!-- {
453+
"blockType": "response",
454+
"truncated": true,
455+
"@odata.type": "microsoft.graph.customAuthenticationExtension"
456+
}
457+
-->
458+
``` http
459+
HTTP/1.1 201 Created
460+
Content-Type: application/json
461+
462+
{
463+
"@odata.type": "#microsoft.graph.onOtpSendCustomExtension",
464+
"authenticationConfiguration": {
465+
"@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
466+
"resourceId": "api://onotpsendcustomextension.b2c.expert/fb96de85-2abe-4b02-b45f-64ba122c509e"
467+
},
468+
"clientConfiguration": {
469+
"timeoutInMilliseconds": 2000,
470+
"maximumRetries": 1
471+
},
472+
"description": "Use an external Email provider to send OTP Codes.",
473+
"displayName": "onEmailOtpSendCustomExtension",
474+
"endpointConfiguration": {
475+
"@odata.type": "#microsoft.graph.httpRequestEndpoint",
476+
"targetUrl": "https://onotpsendcustomextension.b2c.expert/api/OnOTPCodeSendToTeamsDemo"
477+
},
478+
"behaviorOnError": {
479+
"@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
480+
}
481+
}
482+
```

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,5 +111,4 @@ Content-Type: application/json
111111
}
112112
}
113113
}
114-
```
115-
114+
```

0 commit comments

Comments
 (0)