Skip to content

Commit 7fb57d2

Browse files
author
Akul Loomba
committed
Updating docs as per changes requested by Faith
1 parent 227e68f commit 7fb57d2

File tree

3 files changed

+119
-3
lines changed

3 files changed

+119
-3
lines changed

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

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,3 +218,119 @@ Content-Type: application/json
218218
"appId": "63856651-13d9-4784-9abf-20758d509e19"
219219
}
220220
```
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 activate telecom in a region, where the example region codes are 222 and 998.
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+
336+
```

api-reference/beta/resources/phoneoptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Defines the calling codes to opt-in and opt-out for telephony services in [exter
1818
## Properties
1919
|Property|Type|Description|
2020
|:---|:---|:---|
21-
|defaultRegions|Int16 collection|A read-only, Microsoft-defined list of regions that already enable MFA. For more information check out the following [list of countries]("https://learn.microsoft.com/en-us/entra/external-id/customers/how-to-region-code-opt-in")|
21+
|defaultRegions|Int16 collection|A read-only, Microsoft-defined list of regions that already enable MFA. For more information check out the following [list of countries](/entra/external-id/customers/how-to-region-code-opt-in)|
2222
|excludeRegions|Int16 collection|A numbers-only set representing the region telecom codes to prevent or disable the telephony service. Validates against current International Subscriber Dialing (ISD) country codes where the maximum code length is 4. Values must be non-null.|
23-
|includeAdditionalRegions|Int16 collection| A numbers-only set representing the country codes that can be manually added to enable telephony service in those regions, in addition to the list of countries that are already enabled. For more information about regions that require opt-in, see [Regions that need to opt in for MFA telephony verification](/entra/identity/authentication/concept-mfa-regional-opt-in). Validates against current International Subscriber Dialing (ISD) country codes where the maximum code length is 4. Values must be positive integers and cannot overlap with 'excludeRegions'. |
23+
|includeAdditionalRegions|Int16 collection| A numbers-only set representing the country codes that can be manually added to enable telephony service in those regions, in addition to the list of countries that are already enabled. For more information about regions that require opt-in, see [Regions that need to opt in for MFA telephony verification](/entra/external-id/customers/how-to-region-code-opt-in). Validates against current International Subscriber Dialing (ISD) country codes where the maximum code length is 4. Values must be positive integers and cannot overlap with 'excludeRegions'. |
2424

2525
## Relationships
2626
None.

api-reference/beta/toc/toc.mapping.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1467,7 +1467,7 @@
14671467
"onInteractiveAuthFlowStartListener",
14681468
"onTokenIssuanceStartListener",
14691469
"onUserCreateStartListener",
1470-
"onphonemethodloadstartlistener"
1470+
"onPhoneMethodLoadStartListener"
14711471
]
14721472
},
14731473
{

0 commit comments

Comments
 (0)