Skip to content

smsauthenticationmethodconfiguration-get.md

Latest commit

 

History

History
122 lines (96 loc) · 4.66 KB

smsauthenticationmethodconfiguration-get.md

File metadata and controls

122 lines (96 loc) · 4.66 KB
title Get smsAuthenticationMethodConfiguration
description Read the properties and relationships of a smsAuthenticationMethodConfiguration object.
author luc-msft
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 04/05/2024

Get smsAuthenticationMethodConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Read the properties and relationships of a smsAuthenticationMethodConfiguration object, which represents the SMS authentication method policy for the Microsoft Entra tenant.

[!INCLUDE national-cloud-support]

Permissions

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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-policy-apis-read]

HTTP request

GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a smsAuthenticationMethodConfiguration object in the response body.

Examples

Request

HTTP

GET https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/sms

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#authenticationMethodConfigurations/$entity",
    "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration",
    "id": "Sms",
    "state": "enabled",
    "includeTargets": [
        {
            "targetType": "group",
            "id": "all_users",
            "isRegistrationRequired": false,
            "isUsableForSignIn": true
        }
    ],
    "excludeTargets": []
}