Skip to content

emailauthenticationmethodconfiguration.md

Latest commit

 

History

History
71 lines (57 loc) · 3.31 KB

emailauthenticationmethodconfiguration.md

File metadata and controls

71 lines (57 loc) · 3.31 KB
title emailAuthenticationMethodConfiguration resource type
description Represents an email OTP authentication methods policy
author tilarso
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type resourcePageType
toc.title Email
ms.date 07/19/2024

emailAuthenticationMethodConfiguration resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents this tenant's email one-time passcode (OTP) authentication methods policy. Authentication methods policies define configuration settings and users or groups who are enabled to use the authentication method. The tenant's cloud-native users may use email OTP for self-service password reset. External users can use email OTP for authentication during invitation redemption and self-service sign-up for specific apps in user flows.

Inherits from authenticationMethodConfiguration.

Methods

Method Return type Description
Get emailAuthenticationMethodConfiguration Read the properties and relationships of an emailAuthenticationMethodConfiguration object.
Update None Update the properties of an emailAuthenticationMethodConfiguration object.
Delete None Reverts the emailAuthenticationMethodConfiguration object to its default configuration.

Properties

Property Type Description
allowExternalIdToUseEmailOtp externalEmailOtpState Determines whether email OTP is usable by external users for authentication. The possible values are: default, enabled, disabled, unknownFutureValue. Tenants in the default state who didn't use the beta API automatically have email OTP enabled beginning in October 2021.
excludeTargets excludeTarget collection Groups of users that are excluded from the policy.
id String The authentication method policy identifier. Inherited from authenticationMethodConfiguration.
state authenticationMethodState Indicates whether this authentication method is enabled or not. The possible values are: enabled, disabled.

Relationships

Relationship Type Description
includeTargets authenticationMethodTarget collection A collection of groups that are enabled to use the authentication method.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.emailAuthenticationMethodConfiguration",
  "allowExternalIdToUseEmailOtp": "String",
    "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ],
  "id": "String (identifier)",
  "includeTargets": [ { "@odata.type": "microsoft.graph.authenticationMethodTarget" } ],
  "state": "String"
}