Tag: SelectedEditAuthenticationMethods
The SelectedEditAuthenticationMethods action enables the automation of MFA data modification for the users selected in the grid.
<SelectedEditAuthenticationMethods/>
Tag Attributes
|
Attributes |
Attribute Value |
Value Description |
|---|---|---|
|
KeepAlive |
TRUE (keeps dialog open) / FALSE - Defaults to FALSE |
Opens the Edit dialog. Uses SetParam children actions to assign new values to attributes of the objects selected in the grid - Required (Like when using the Edit Function Manually) |
Load the data first: run SelectedUserLoadMore with Load="AuthOverview" (Authentication Methods Overview) before setting RequirementState or DefaultMethod, and with Load="AuthDetails" (Authentication Methods Details) before setting Methods. Otherwise the action fails with "GUI control not enabled" or "Selection not available in list".
Field names aren't checked: a misspelled or obsolete field is ignored without any error. Each value is set with a separate SetParam:
-
Changing Requirement State: VALUE can be "Enabled", "Enforced" or "Disabled".
<SetParam Field="RequirementState" Value="VALUE"/>
-
Removing all methods (forcing users to re-register) is not available in automation: the former ForceUserToReRegister field no longer exists. A script that still sets it runs without error but changes nothing.
-
Change methods: add one SetParam for each method type to keep. Every type not listed is removed from all selected users. A user's methods of the same type are kept or removed together. Only types that at least one selected user has registered are accepted. The password method can't be removed. Use the type names below: the on-screen labels don't match when several users are selected. Removing a QR code authentication method (qrCodePinAuthenticationMethod) currently fails when saving.
VALUE can be "emailAuthenticationMethod", "fido2AuthenticationMethod", "hardwareOathAuthenticationMethod", "microsoftAuthenticatorAuthenticationMethod", "passwordlessMicrosoftAuthenticatorAuthenticationMethod", "phoneAuthenticationMethod", "softwareOathAuthenticationMethod", "temporaryAccessPassAuthenticationMethod", "windowsHelloForBusinessAuthenticationMethod", "platformCredentialAuthenticationMethod" or "qrCodePinAuthenticationMethod".
<SetParam Field="Methods" Value="VALUE"/>
-
Set default method:
VALUE can be "push", "oath", "voiceMobile", "voiceAlternateMobile", "voiceOffice" or "sms".
<SetParam Field="DefaultMethod" Value="VALUE"/>
Migrating from SelectedEditMFA: scripts that still use the old tag stop with an unknown-action error. Rename the tag and replace the old values, which are now rejected:
DefaultMethod: OneWaySMS → sms, TwoWayVoiceMobile → voiceMobile, TwoWayVoiceAlternateMobile → voiceAlternateMobile, TwoWayVoiceOffice → voiceOffice, PhoneAppOTP → oath, PhoneAppNotification → push.
Methods: OneWaySMS and the TwoWayVoice values → phoneAuthenticationMethod, PhoneAppNotification → microsoftAuthenticatorAuthenticationMethod, PhoneAppOTP → microsoftAuthenticatorAuthenticationMethod or softwareOathAuthenticationMethod, depending on the app.
ForceUserToReRegister: remove it, it no longer has any effect.
Example Script
<ytriaAutomation Application="sapio365">
<Select Lines="ByValue">
<SetParam ColumnID="userPrincipalName" Value="AnnaL@M365x308674.onmicrosoft.com"/>
</Select>
<SelectedUserLoadMore Load="AuthOverview;AuthDetails"/>
<SelectedEditAuthenticationMethods>
<SetParam Field="RequirementState" Value="Enforced"/>
<SetParam Field="DefaultMethod" Value="push"/>
<SetParam Field="Methods" Value="microsoftAuthenticatorAuthenticationMethod"/>
<SetParam Field="Methods" Value="phoneAuthenticationMethod"/>
</SelectedEditAuthenticationMethods>
<SaveSelected/>
</ytriaAutomation>