Skip to content

Latest commit

 

History

History
136 lines (103 loc) · 5.17 KB

File metadata and controls

136 lines (103 loc) · 5.17 KB
title Get emailAuthenticationMethod
description Retrieve a user's emailAuthenticationMethod object.
author tilarso
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 06/07/2024

Get emailAuthenticationMethod

Namespace: microsoft.graph

Retrieve a user's single email authentication method object.

[!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.

Permissions acting on self

[!INCLUDE permissions-table]

Permissions acting on other users

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) UserAuthenticationMethod.Read.All UserAuthenticationMethod.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application UserAuthenticationMethod.Read.All UserAuthenticationMethod.ReadWrite.All

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

HTTP request

The ID of the email authentication method, referenced by {emailMethods-id}, is always 3ddfcfc8-9383-446f-83cc-3ab9be4be18f.

Get details of your own email authentication method.

GET /me/authentication/emailMethods/{emailMethods-id}

[!INCLUDE me-apis-sign-in-note]

Get details of your own or another user's email authentication method.

GET /users/{id | userPrincipalName}/authentication/emailMethods/{emailMethods-id}

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 the requested emailAuthenticationMethod object in the response body.

Examples

Request

GET https://graph.microsoft.com/v1.0/me/authentication/emailMethods/3ddfcfc8-9383-446f-83cc-3ab9be4be18f

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

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

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

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

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

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

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

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


Response

The following example shows the response.

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

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

{
  "value": {
      "id": "3ddfcfc8-9383-446f-83cc-3ab9be4be18f",
      "emailAddress": "Kim@contoso.com"
  }
}