Skip to content

Commit 6367c27

Browse files
FaithOmbongiFaithOmbongi
authored
Make various fixes
1 parent 5019eaf commit 6367c27

6 files changed

+152
-124
lines changed

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

Lines changed: 1 addition & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ The following example shows the response.
144144
``` http
145145
HTTP/1.1 204 No Content
146146
```
147+
147148
### Example 2: Add an application to an authentication event listener's trigger conditions
148149

149150
#### Request
@@ -217,120 +218,4 @@ Content-Type: application/json
217218
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventListeners('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity",
218219
"appId": "63856651-13d9-4784-9abf-20758d509e19"
219220
}
220-
```
221-
### Example 3: Activate telecom in a region, we're using region codes 222 and 998
222-
# [HTTP](#tab/http)
223-
224-
```http
225-
226-
227-
POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
228-
{
229-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
230-
"conditions": {
231-
"applications": {
232-
"includeApplications": [
233-
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
234-
]
235-
}
236-
},
237-
"priority": 500,
238-
"handler": {
239-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler",
240-
/* An Admin can state the country codes they would like to opt in or opt out from. */
241-
{
242-
"includeAdditionalRegions": [222, 998],
243-
"excludeRegions": []
244-
}
245-
}
246-
}
247-
248-
```
249-
250-
#### Response
251-
The following example shows the response to a request to to activate telecom in a region, where the example region codes are 222 and 998.
252-
```http
253-
254-
HTTP/1.1 201 Created
255-
{
256-
"@odata.context": "https://microsoft.graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
257-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
258-
"id": "2be3336b-e3b4-44f3-9128-b6fd9ad39bb8",
259-
"conditions": {
260-
"applications": {
261-
"includeApplications": [
262-
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
263-
]
264-
}
265-
},
266-
"handler":
267-
{
268-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler ",
269-
{
270-
"includeAdditionalRegions": [222, 998],
271-
"excludeRegions": []
272-
},
273-
}
274-
}
275-
276-
277-
```
278-
279-
280-
### Example 4: Deactivate telecom in a region, we're using region codes 1001, 99, 777 for this example
281-
# [HTTP](#tab/http)
282-
283-
```http
284-
285-
286-
POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
287-
{
288-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
289-
"conditions": {
290-
"applications": {
291-
"includeApplications": [
292-
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
293-
]
294-
}
295-
},
296-
"priority": 500,
297-
"handler": {
298-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler",
299-
/* An Admin can state the country codes they would like to opt in or opt out from. */
300-
{
301-
"includeAdditionalRegions": [],
302-
"excludeRegions": [1001, 99, 777]
303-
}
304-
}
305-
}
306-
307-
308-
```
309-
310-
#### Response
311-
The following example shows the response to a request to to deactivatge telecom in a region, where the example region codes are 1001, 999, 777.
312-
```http
313-
314-
HTTP/1.1 201 Created
315-
{
316-
"@odata.context": "https://microsoft.graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
317-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartListener",
318-
"id": "2be3336b-e3b4-44f3-9128-b6fd9ad39bb8",
319-
"conditions": {
320-
"applications": {
321-
"includeApplications": [
322-
"3dfff01b-0afb-4a07-967f-d1ccbd81102a"
323-
]
324-
}
325-
},
326-
"handler":
327-
{
328-
"@odata.type": "#microsoft.graph.onPhoneMethodLoadStartExternalUsersAuthHandler ",
329-
{
330-
"includeAdditionalRegions": [],
331-
"excludeRegions": [1001, 99, 777]
332-
},
333-
}
334-
}
335-
336221
```

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

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,3 +396,142 @@ Content-Type: application/json
396396
}
397397
}
398398
```
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/onphonemethodloadstartexternalusersauthhandler.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "onPhoneMethodLoadStartExternalUsersAuthHandler resource type"
3-
description: "Represents a step in a multi-event user flow policy defining what happens when telephony methods are ready to be presented to the user."
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."
44
author: "aloom3"
5-
ms.date: 01/14/2025
5+
ms.date: 02/05/2025
66
ms.localizationpriority: medium
77
ms.subservice: "entra-sign-in"
88
doc_type: resourcePageType
@@ -14,7 +14,8 @@ Namespace: microsoft.graph
1414

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

17-
A managed handler that defines what calling codes are enabled or disabled for telephony services in an [external identities user flow for Microsft Entra external tenants] (../resources/authenticationevents.flow.md).
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+
1819
This configuration enumerates what region codes can be opted-in or out for SMS or voice MFA.
1920

2021

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
title: "onPhoneMethodLoadStartHandler resource type"
3-
description: "Represents a step in a multi-event user flow policy defining what happens when telephony methods are ready to be presented to the user."
3+
description: "Used for configuring the telephony settings for enabling or disabling MFA in an external identities user flow for Microsoft Entra external tenants."
44
author: "aloom3"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: resourcePageType
8+
ms.date: 02/05/2025
89
---
910

1011
# onPhoneMethodLoadStartHandler resource type
@@ -13,9 +14,9 @@ Namespace: microsoft.graph
1314

1415
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1516

16-
Used for configuring the telephony settings for enabling or disabling MFA as defined in the **onPhoneMethodLoadStartHandler** event in an [externalUsersSelfServiceSignUpEventsFlow](externalUsersSelfServiceSignUpEventsFlow.md) user flow type.
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.
1718

18-
This is an abstract complex type from which the [onphonemethodLoadStartExternalUsersAuthHandler](../resources/onphonemethodloadsstartexternalusersauthhandler.md) subtype is derived.
19+
This is an abstract complex type from which the [onPhoneMethodLoadStartExternalUsersAuthHandler](../resources/onphonemethodloadstartexternalusersauthhandler.md) subtype is derived.
1920

2021
## Properties
2122
None.

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
title: "onPhoneMethodLoadStartListener resource type"
3-
description: "Represents a step in a multi-event user flow policy defining what happens when telephony methods are ready to be presented to the user."
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."
44
author: "aloom3"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
77
doc_type: resourcePageType
8+
ms.date: 02/05/2025
89
---
910

1011
# onPhoneMethodLoadStartListener resource type
@@ -13,7 +14,7 @@ Namespace: microsoft.graph
1314

1415
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1516

16-
Used for configuring the telephony settings for enabling or disabling MFA as defined in the **onPhoneMethodLoadStart** event in an [externalUsersSelfServiceSignUpEventsFlow](externalUsersSelfServiceSignUpEventsFlow.md) user flow type. If this listener isn't specified, the default list of calling regions are enabled for MFA.
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.
1718

1819
Inherits from [authenticationEventListener](../resources/authenticationeventlistener.md).
1920

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: "Defines the calling codes to opt-in and opt-out for telephony serv
44
author: "aloom3"
55
ms.localizationpriority: medium
66
ms.subservice: "entra-sign-in"
7+
ms.date: 02/05/2025
78
doc_type: resourcePageType
89
---
910

0 commit comments

Comments
 (0)