Skip to content

authenticationmethodsregistrationcampaign.md

Latest commit

 

History

History
56 lines (49 loc) · 2.68 KB

authenticationmethodsregistrationcampaign.md

File metadata and controls

56 lines (49 loc) · 2.68 KB
title authenticationMethodsRegistrationCampaign resource type
description Represents the settings used to run campaigns to push users to set up targeted authentication methods.
author luc-msft
ms.reviewer intelligentaccesspm
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type resourcePageType
ms.date 07/22/2024

authenticationMethodsRegistrationCampaign resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Represents the settings used to run campaigns to push users to set up targeted authentication methods. Users are prompted to set up the authentication method after they successfully complete a MFA challenge. Only available for the Microsoft Authenticator app for MFA.

Properties

Property Type Description
enforceRegistrationAfterAllowedSnoozes Boolean Specifies whether a user is required to perform registration after snoozing 3 times. If true, the user is required to register after 3 snoozes. If false, the user can snooze indefinitely. The default value is true.
excludeTargets excludeTarget collection Users and groups of users that are excluded from being prompted to set up the authentication method.
includeTargets authenticationMethodsRegistrationCampaignIncludeTarget collection Users and groups of users that are prompted to set up the authentication method.
snoozeDurationInDays Int32 Specifies the number of days that the user sees a prompt again if they select "Not now" and snoozes the prompt. Minimum 0 days. Maximum: 14 days. If the value is 0 – The user is prompted during every MFA attempt.
state advancedConfigState Enable or disable the feature. The possible values are: default, enabled, disabled, unknownFutureValue. The default value is used when the configuration hasn't been explicitly set and uses the default behavior of Microsoft Entra ID for the setting. The default value is disabled.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.authenticationMethodsRegistrationCampaign",
  "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ],
  "includeTargets": [
    {
      "@odata.type": "microsoft.graph.authenticationMethodsRegistrationCampaignIncludeTarget"
    }
  ],
  "snoozeDurationInDays": "Integer",
  "enforceRegistrationAfterAllowedSnoozes": "Boolean",
  "state": "String"
}