Skip to content

authentication-list-emailmethods.md

Latest commit

 

History

History
137 lines (102 loc) · 5.23 KB

authentication-list-emailmethods.md

File metadata and controls

137 lines (102 loc) · 5.23 KB
title List emailMethods
description Get a list of the emailAuthenticationMethod objects for a user.
author tilarso
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 06/07/2024

List emailMethods

Namespace: microsoft.graph

Retrieve a list of a user's email Authentication Method objects and their properties. This call only returns a single object referenced by ID 3ddfcfc8-9383-446f-83cc-3ab9be4be18f as only one email method can be set on users.

[!INCLUDE national-cloud-support]

Permissions

The following tables show the least privileged permission or permissions required to call this API on each supported resource type. Follow best practices to request least privileged permissions. 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

[!INCLUDE permissions-table]

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

HTTP request

Get details of your own email authentication method.

GET /me/authentication/emailMethods

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

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

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

Optional query parameters

This method does not support optional query parameters to customize the response.

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 collection of emailAuthenticationMethod objects in the response body. Only one emailAuthenticationMethod object is returned in the collection as only one email method can be set for a user.

Examples

Request

HTTP

GET https://graph.microsoft.com/v1.0/me/authentication/emailMethods

C#

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

CLI

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

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"
    }
  ]
}