Share via

Update-MgIdentityAuthenticationEventFlow

Module:
Microsoft.Graph.Identity.SignIns Module

Update the properties of an authenticationEventsFlow object by ID. You must specify the @odata.type property and the value of the authenticationEventsFlow object type to update. The following derived subtypes are supported:- externalUsersSelfServiceSignupEventsFlow

Note

To view the beta release of this cmdlet, view Update-MgBetaIdentityAuthenticationEventFlow

Syntax

UpdateExpanded (Default) 

Update-MgIdentityAuthenticationEventFlow
    -AuthenticationEventsFlowId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Conditions <IMicrosoftGraphAuthenticationConditions>]
    [-Description <string>]
    [-DisplayName <string>]
    [-Id <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgIdentityAuthenticationEventFlow
    -AuthenticationEventsFlowId <string>
    -BodyParameter <IMicrosoftGraphAuthenticationEventsFlow>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgIdentityAuthenticationEventFlow
    -InputObject <IIdentitySignInsIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-Conditions <IMicrosoftGraphAuthenticationConditions>]
    [-Description <string>]
    [-DisplayName <string>]
    [-Id <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgIdentityAuthenticationEventFlow
    -InputObject <IIdentitySignInsIdentity>
    -BodyParameter <IMicrosoftGraphAuthenticationEventsFlow>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of an authenticationEventsFlow object by ID. You must specify the @odata.type property and the value of the authenticationEventsFlow object type to update. The following derived subtypes are supported:- externalUsersSelfServiceSignupEventsFlow

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) EventListener.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application EventListener.ReadWrite.All,

Examples

Example 1: Update the display name of an external identities self-service sign-up user flow


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow"
	displayName = "New user flow description"
}

Update-MgIdentityAuthenticationEventFlow -AuthenticationEventsFlowId $authenticationEventsFlowId -BodyParameter $params

This example will update the display name of an external identities self-service sign-up user flow

Example 2: Update the page layout of a self-service sign up user flow


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow"
	onAttributeCollection = @{
		"@odata.type" = "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp"
		attributeCollectionPage = @{
			views = @(
				@{
					title = $null
					description = $null
					inputs = @(
						@{
							attribute = "email"
							label = "Email Address"
							inputType = "text"
							defaultValue = $null
							hidden = $true
							editable = $false
							writeToDirectory = $true
							required = $true
							validationRegEx = "^[a-zA-Z0-9.!#$%&amp;&#8217;'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$"
							options = @(
							)
						}
						@{
							attribute = "displayName"
							label = "Display Name"
							inputType = "text"
							defaultValue = $null
							hidden = $false
							editable = $true
							writeToDirectory = $true
							required = $true
							validationRegEx = "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$"
							options = @(
							)
						}
						@{
							attribute = "city"
							label = "City"
							inputType = "text"
							defaultValue = $null
							hidden = $false
							editable = $true
							writeToDirectory = $true
							required = $true
							validationRegEx = "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$"
							options = @(
							)
						}
						@{
							attribute = "extension_331d514c0c18477583ea7dd5a79feda2_RockorCountry"
							label = "Rock music or Country"
							inputType = "radioSingleSelect"
							defaultValue = $null
							hidden = $false
							editable = $true
							writeToDirectory = $true
							required = $true
							validationRegEx = "^.*"
							options = @(
								@{
									label = "Rock music"
									value = "Rock"
								}
								@{
									label = "Country music"
									value = "Country"
								}
							)
						}
					)
				}
			)
		}
	}
}

Update-MgIdentityAuthenticationEventFlow -AuthenticationEventsFlowId $authenticationEventsFlowId -BodyParameter $params

This example will update the page layout of a self-service sign up user flow

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AuthenticationEventsFlowId

The unique identifier of authenticationEventsFlow

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

authenticationEventsFlow To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationEventsFlow
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Conditions

authenticationConditions To construct, see NOTES section for CONDITIONS properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationConditions
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

The description of the events policy.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

Required. The display name for the events policy.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IIdentitySignInsIdentity
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IIdentitySignInsIdentity

{{ Fill in the Description }}

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationEventsFlow

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationEventsFlow

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphAuthenticationEventsFlow>: authenticationEventsFlow [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [Conditions <IMicrosoftGraphAuthenticationConditions>]: authenticationConditions [(Any) <Object>]: This indicates any property can be added to this object. [Applications <IMicrosoftGraphAuthenticationConditionsApplications>]: authenticationConditionsApplications [(Any) <Object>]: This indicates any property can be added to this object. [IncludeApplications <IMicrosoftGraphAuthenticationConditionApplication[]>]: [AppId <String>]: The identifier for an application corresponding to a condition which will trigger an authenticationEventListener. [Description <String>]: The description of the events policy. [DisplayName <String>]: Required. The display name for the events policy.

CONDITIONS <IMicrosoftGraphAuthenticationConditions>: authenticationConditions [(Any) <Object>]: This indicates any property can be added to this object. [Applications <IMicrosoftGraphAuthenticationConditionsApplications>]: authenticationConditionsApplications [(Any) <Object>]: This indicates any property can be added to this object. [IncludeApplications <IMicrosoftGraphAuthenticationConditionApplication[]>]: [AppId <String>]: The identifier for an application corresponding to a condition which will trigger an authenticationEventListener.

INPUTOBJECT <IIdentitySignInsIdentity>: Identity Parameter [ActivityBasedTimeoutPolicyId <String>]: The unique identifier of activityBasedTimeoutPolicy [AppManagementPolicyId <String>]: The unique identifier of appManagementPolicy [AuthenticationCombinationConfigurationId <String>]: The unique identifier of authenticationCombinationConfiguration [AuthenticationConditionApplicationAppId <String>]: The unique identifier of authenticationConditionApplication [AuthenticationContextClassReferenceId <String>]: The unique identifier of authenticationContextClassReference [AuthenticationEventListenerId <String>]: The unique identifier of authenticationEventListener [AuthenticationEventsFlowId <String>]: The unique identifier of authenticationEventsFlow [AuthenticationMethodConfigurationId <String>]: The unique identifier of authenticationMethodConfiguration [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod [AuthenticationMethodModeDetailId <String>]: The unique identifier of authenticationMethodModeDetail [AuthenticationStrengthPolicyId <String>]: The unique identifier of authenticationStrengthPolicy [B2XIdentityUserFlowId <String>]: The unique identifier of b2xIdentityUserFlow [BitlockerRecoveryKeyId <String>]: The unique identifier of bitlockerRecoveryKey [CertificateBasedAuthConfigurationId <String>]: The unique identifier of certificateBasedAuthConfiguration [ClaimsMappingPolicyId <String>]: The unique identifier of claimsMappingPolicy [ConditionalAccessPolicyId <String>]: The unique identifier of conditionalAccessPolicy [ConditionalAccessTemplateId <String>]: The unique identifier of conditionalAccessTemplate [CrossTenantAccessPolicyConfigurationPartnerTenantId <String>]: The unique identifier of crossTenantAccessPolicyConfigurationPartner [CustomAuthenticationExtensionId <String>]: The unique identifier of customAuthenticationExtension [DataPolicyOperationId <String>]: The unique identifier of dataPolicyOperation [DirectoryObjectId <String>]: The unique identifier of directoryObject [EmailAuthenticationMethodId <String>]: The unique identifier of emailAuthenticationMethod [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy [Fido2AuthenticationMethodId <String>]: The unique identifier of fido2AuthenticationMethod [HomeRealmDiscoveryPolicyId <String>]: The unique identifier of homeRealmDiscoveryPolicy [IdentityApiConnectorId <String>]: The unique identifier of identityApiConnector [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase [IdentityProviderId <String>]: The unique identifier of identityProvider [IdentityUserFlowAttributeAssignmentId <String>]: The unique identifier of identityUserFlowAttributeAssignment [IdentityUserFlowAttributeId <String>]: The unique identifier of identityUserFlowAttribute [LongRunningOperationId <String>]: The unique identifier of longRunningOperation [MicrosoftAuthenticatorAuthenticationMethodId <String>]: The unique identifier of microsoftAuthenticatorAuthenticationMethod [MultiTenantOrganizationMemberId <String>]: The unique identifier of multiTenantOrganizationMember [NamedLocationId <String>]: The unique identifier of namedLocation [OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant [OrganizationId <String>]: The unique identifier of organization [PasswordAuthenticationMethodId <String>]: The unique identifier of passwordAuthenticationMethod [PermissionGrantConditionSetId <String>]: The unique identifier of permissionGrantConditionSet [PermissionGrantPolicyId <String>]: The unique identifier of permissionGrantPolicy [PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod [PlatformCredentialAuthenticationMethodId <String>]: The unique identifier of platformCredentialAuthenticationMethod [RiskDetectionId <String>]: The unique identifier of riskDetection [RiskyServicePrincipalHistoryItemId <String>]: The unique identifier of riskyServicePrincipalHistoryItem [RiskyServicePrincipalId <String>]: The unique identifier of riskyServicePrincipal [RiskyUserHistoryItemId <String>]: The unique identifier of riskyUserHistoryItem [RiskyUserId <String>]: The unique identifier of riskyUser [ServicePrincipalRiskDetectionId <String>]: The unique identifier of servicePrincipalRiskDetection [SoftwareOathAuthenticationMethodId <String>]: The unique identifier of softwareOathAuthenticationMethod [TemporaryAccessPassAuthenticationMethodId <String>]: The unique identifier of temporaryAccessPassAuthenticationMethod [ThreatAssessmentRequestId <String>]: The unique identifier of threatAssessmentRequest [ThreatAssessmentResultId <String>]: The unique identifier of threatAssessmentResult [TokenIssuancePolicyId <String>]: The unique identifier of tokenIssuancePolicy [TokenLifetimePolicyId <String>]: The unique identifier of tokenLifetimePolicy [UnifiedRoleManagementPolicyAssignmentId <String>]: The unique identifier of unifiedRoleManagementPolicyAssignment [UnifiedRoleManagementPolicyId <String>]: The unique identifier of unifiedRoleManagementPolicy [UnifiedRoleManagementPolicyRuleId <String>]: The unique identifier of unifiedRoleManagementPolicyRule [UserFlowLanguageConfigurationId <String>]: The unique identifier of userFlowLanguageConfiguration [UserFlowLanguagePageId <String>]: The unique identifier of userFlowLanguagePage [UserId <String>]: The unique identifier of user [WindowsHelloForBusinessAuthenticationMethodId <String>]: The unique identifier of windowsHelloForBusinessAuthenticationMethod