Skip to content

Commit 71ffc9e

Browse files
DanielabomDanielabom
authored
Merge pull request #25965 from microsoftgraph/preview-regional-opt-in
Adding regional activator/deactivator pieces
2 parents c160332 + f170a86 commit 71ffc9e

9 files changed

+427
-2
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Update the properties of an [authenticationEventListener](../resources/authentic
2222
- [onUserCreateStartListener resource type](../resources/onusercreatestartlistener.md) resource type
2323
- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) resource type
2424
- [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) resource type
25+
- [onPhoneMethodLoadStartListener](../resources/onphonemethodloadstartlistener.md) resource type
2526

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

@@ -65,6 +66,7 @@ You must specify the **@odata.type** property and the value of the [authenticati
6566
|handler|[onUserCreateStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onUserCreateStartListener** listener type.|
6667
|handler|[onAttributeCollectionStartHandler](../resources/onattributecollectionstarthandler.md)|The handler to invoke when conditions are met. Can be updated for the **onAttributeCollectionStartListener** listener type.|
6768
|handler|[onAttributeCollectionSubmitHandler](../resources/onattributecollectionsubmithandler.md)|The handler to invoke when conditions are met. Can be updated for the **onAttributeCollectionSubmitListener** listener type.|
69+
|handler|[onPhoneMethodLoadStartHandler](../resources/onphonemethodloadstarthandler.md) | The handler to invoke when conditions are met. Can be updated for the **onPhoneMethodStartListener** type. |
6870
|priority|Int32|The priority of this handler. Between 0 (lower priority) and 1000 (higher priority). Required.|
6971

7072
## Response
@@ -142,6 +144,7 @@ The following example shows the response.
142144
``` http
143145
HTTP/1.1 204 No Content
144146
```
147+
145148
### Example 2: Add an application to an authentication event listener's trigger conditions
146149

147150
#### Request
@@ -215,4 +218,4 @@ Content-Type: application/json
215218
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventListeners('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity",
216219
"appId": "63856651-13d9-4784-9abf-20758d509e19"
217220
}
218-
```
221+
```

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

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Create a new [authenticationEventListener](../resources/authenticationeventliste
2222
- [onUserCreateStartListener resource type](../resources/onusercreatestartlistener.md)
2323
- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md)
2424
- [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md)
25+
- [onPhoneMethodLoadStartListener](../resources/onphonemethodloadstartlistener.md)
2526

2627
> [!NOTE]
2728
>
@@ -69,8 +70,10 @@ You can specify the following properties when creating an **authenticationEventL
6970
|handler|[onInteractiveAuthFlowStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be set for the **onInteractiveAuthFlowStartListener** listener type.|
7071
|handler|[onTokenIssuanceStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be set for the **onTokenIssuanceStartListener** listener type.|
7172
|handler|[onUserCreateStartHandler](../resources/ontokenissuancestarthandler.md)|The handler to invoke when conditions are met. Can be set for the **onUserCreateStartListener** listener type.|
73+
|handler|[onPhoneMethodLoadStartHandler](../resources/onphonemethodloadstarthandler.md) | The handler to invoke when conditions are met. Can be set for the **onPhoneMethodLoadStartListener** listener type. |
7274
|priority|Int32| The priority of this handler. Between 0 (lower priority) and 1000 (higher priority). Required.|
7375

76+
7477
## Response
7578

7679
If successful, this method returns a `201 Created` response code and an [authenticationEventListener](../resources/authenticationeventlistener.md) object in the response body. The **@odata.type** property specifies the type of the created object.
@@ -393,3 +396,142 @@ Content-Type: application/json
393396
}
394397
}
395398
```
399+
400+
### Example 3: Activate telecom for select regions
401+
402+
#### Request
403+
The following example shows a request that activates telecom in region codes 222 and 998.
404+
405+
<!-- {
406+
"blockType": "request",
407+
"name": "create_authenticationeventlistener_onPhoneMethodLoadStartExternalUsersAuthHandler_activate"
408+
}
409+
-->
410+
```http
411+
POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
412+
Content-Type: application/json
413+
414+
{
415+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
416+
"conditions": {
417+
"applications": {
418+
"includeApplications": [
419+
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
420+
]
421+
}
422+
},
423+
"priority": 500,
424+
"handler": {
425+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler",
426+
"smsOptions": {
427+
"includeAdditionalRegions": [222, 998],
428+
"excludeRegions": []
429+
}
430+
}
431+
}
432+
```
433+
434+
#### Response
435+
436+
The following example shows the response.
437+
>**Note:** The response object shown here might be shortened for readability.
438+
<!-- {
439+
"blockType": "response",
440+
"truncated": true,
441+
"@odata.type": "microsoft.graph.authenticationEventListener"
442+
}
443+
-->
444+
``` http
445+
HTTP/1.1 201 Created
446+
Content-Type: application/json
447+
448+
{
449+
"@odata.context": "https://microsoft.graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
450+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
451+
"id": "2be3336b-e3b4-44f3-9128-b6fd9ad39bb8",
452+
"conditions": {
453+
"applications": {
454+
"includeApplications": [
455+
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
456+
]
457+
}
458+
},
459+
"handler": {
460+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler ",
461+
"smsOptions": {
462+
"includeAdditionalRegions": [222, 998],
463+
"excludeRegions": []
464+
},
465+
}
466+
}
467+
```
468+
469+
470+
### Example 4: Deactivate telecom in select regions
471+
472+
#### Request
473+
The following example shows a request that deactivates telecom in region codes 1001, 99, and 777.
474+
475+
<!-- {
476+
"blockType": "request",
477+
"name": "create_authenticationeventlistener_onPhoneMethodLoadStartExternalUsersAuthHandler_deactivate"
478+
}
479+
-->
480+
```http
481+
POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
482+
Content-Type: application/json
483+
484+
{
485+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
486+
"conditions": {
487+
"applications": {
488+
"includeApplications": [
489+
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
490+
]
491+
}
492+
},
493+
"priority": 500,
494+
"handler": {
495+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler",
496+
"smsOptions": {
497+
"includeAdditionalRegions": [],
498+
"excludeRegions": [1001, 99, 777]
499+
}
500+
}
501+
}
502+
```
503+
504+
#### Response
505+
506+
The following example shows the response.
507+
>**Note:** The response object shown here might be shortened for readability.
508+
<!-- {
509+
"blockType": "response",
510+
"truncated": true,
511+
"@odata.type": "microsoft.graph.authenticationEventListener"
512+
}
513+
-->
514+
``` http
515+
HTTP/1.1 201 Created
516+
Content-Type: application/json
517+
518+
{
519+
"@odata.context": "https://microsoft.graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
520+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
521+
"id": "2be3336b-e3b4-44f3-9128-b6fd9ad39bb8",
522+
"conditions": {
523+
"applications": {
524+
"includeApplications": [
525+
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
526+
]
527+
}
528+
},
529+
"handler": {
530+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler",
531+
"smsOptions": {
532+
"includeAdditionalRegions": [],
533+
"excludeRegions": [1001, 99, 777]
534+
}
535+
}
536+
}
537+
```

‎api-reference/beta/resources/authenticationeventlistener.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ To customize the authentication process, listeners can be registered which speci
2323
- [onUserCreateStartListener resource type](../resources/onusercreatestartlistener.md) resource type
2424
- [onAttributeCollectionStartListener](../resources/onattributecollectionstartlistener.md) resource type
2525
- [onAttributeCollectionSubmitListener](../resources/onattributecollectionsubmitlistener.md) resource type
26+
- [onPhoneMethodLoadStartListener](../resources/onphonemethodloadstartlistener.md)
2627
- [onEmailOtpSendListener](../resources/onemailotpsendlistener.md) resource type
2728

2829
> [!NOTE]

‎api-reference/beta/resources/onphonemethodloadstartexternalusersauthhandler.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: "onPhoneMethodLoadStartExternalUsersAuthHandler resource type"
3+
description: "A managed handler that defines what calling codes are enabled or disabled for telephony services in an external identities user flow for Microsoft Entra external tenants."
4+
author: "aloom3"
5+
ms.date: 02/05/2025
6+
ms.localizationpriority: medium
7+
ms.subservice: "entra-sign-in"
8+
doc_type: resourcePageType
9+
---
10+
11+
# onPhoneMethodLoadStartExternalUsersAuthHandler resource type
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
A managed handler that defines what calling codes are enabled or disabled for telephony services in an [external identities user flow for Microsoft Entra external tenants](../resources/authenticationeventsflow.md).
18+
19+
This configuration enumerates what region codes can be opted-in or out for SMS or voice MFA.
20+
21+
22+
Inherits from [onPhoneMethodLoadStartHandler](../resources/onphonemethodloadstarthandler.md).
23+
24+
25+
## Properties
26+
|Property|Type|Description|
27+
|:---|:---|:---|
28+
|smsOptions|[phoneOptions](../resources/phoneoptions.md)|Telephony options to enable or disable regions for SMS.|
29+
|voiceOptions|[phoneOptions](../resources/phoneoptions.md)|Telephony options to enable or disable regions for voice.|
30+
31+
## Relationships
32+
None.
33+
34+
## JSON representation
35+
The following JSON representation shows the resource type.
36+
<!-- {
37+
"blockType": "resource",
38+
"@odata.type": "microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler"
39+
}
40+
-->
41+
``` json
42+
{
43+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler",
44+
"smsOptions": {
45+
"@odata.type": "microsoft.graph.phoneOptions"
46+
},
47+
"voiceOptions": {
48+
"@odata.type": "microsoft.graph.phoneOptions"
49+
}
50+
}
51+
```
52+

‎api-reference/beta/resources/onphonemethodloadstarthandler.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: "onPhoneMethodLoadStartHandler resource type"
3+
description: "Used for configuring the telephony settings for enabling or disabling MFA in an external identities user flow for Microsoft Entra external tenants."
4+
author: "aloom3"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: resourcePageType
8+
ms.date: 02/05/2025
9+
---
10+
11+
# onPhoneMethodLoadStartHandler resource type
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Used for configuring the telephony settings for enabling or disabling MFA as defined in an external identities user flow for Microsoft Entra external tenants.
18+
19+
This is an abstract complex type from which the [onPhoneMethodLoadStartExternalUsersAuthHandler](../resources/onphonemethodloadstartexternalusersauthhandler.md) subtype is derived.
20+
21+
## Properties
22+
None.
23+
24+
## Relationships
25+
None.
26+
27+
## JSON representation
28+
The following JSON representation shows the resource type.
29+
<!-- {
30+
"blockType": "resource",
31+
"@odata.type": "microsoft.graph.onPhoneMethodLoadStartHandler"
32+
}
33+
-->
34+
``` json
35+
{
36+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartHandler"
37+
}
38+
```
39+

‎api-reference/beta/resources/onphonemethodloadstartlistener.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "onPhoneMethodLoadStartListener resource type"
3+
description: "A listener for when calling codes are enabled or disabled for telephony services in an external identities user flow for Microsoft Entra external tenants."
4+
author: "aloom3"
5+
ms.localizationpriority: medium
6+
ms.subservice: "entra-sign-in"
7+
doc_type: resourcePageType
8+
ms.date: 02/05/2025
9+
---
10+
11+
# onPhoneMethodLoadStartListener resource type
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
A listener for when calling codes are enabled or disabled for telephony services in an external identities user flow for Microsoft Entra external tenants. If this listener isn't specified, the default list of calling regions are enabled for MFA.
18+
19+
Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md).
20+
21+
22+
## Methods
23+
None.
24+
25+
For the list of API operations for managing this resource type, see the [authenticationEventListener](../resources/authenticationeventlistener.md) resource type.
26+
27+
## Properties
28+
|Property|Type|Description|
29+
|:---|:---|:---|
30+
|authenticationEventsFlowId|String|Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).|
31+
|conditions|[authenticationConditions](../resources/authenticationconditions.md)|Required. Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).|
32+
|handler|[onPhoneMethodLoadStartHandler](../resources/onphonemethodloadstarthandler.md)|Required. Configuration for what to invoke if the event resolves to this listener. |
33+
|id|String|Required. Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).|
34+
|priority|Int32|Required. Inherited from [authenticationEventListener](../resources/authenticationeventlistener.md).|
35+
36+
## Relationships
37+
None.
38+
39+
## JSON representation
40+
The following JSON representation shows the resource type.
41+
<!-- {
42+
"blockType": "resource",
43+
"keyProperty": "id",
44+
"@odata.type": "microsoft.graph.onPhoneMethodLoadStartListener",
45+
"baseType": "microsoft.graph.authenticationEventListener",
46+
"openType": false
47+
}
48+
-->
49+
``` json
50+
{
51+
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
52+
"id": "String (identifier)",
53+
"priority": "Integer",
54+
"conditions": {
55+
"@odata.type": "microsoft.graph.authenticationConditions"
56+
},
57+
"authenticationEventsFlowId": "String",
58+
"handler": {
59+
"@odata.type": "microsoft.graph.onPhoneMethodLoadStartHandler"
60+
}
61+
}
62+
```
63+

0 commit comments

Comments
 (0)