Update-MgIdentityCustomAuthenticationExtension

Reference

Module:: Microsoft.Graph.Identity.SignIns

Update the properties of a customAuthenticationExtension object.

Note

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

Syntax

Update-MgIdentityCustomAuthenticationExtension
      -CustomAuthenticationExtensionId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-AuthenticationConfiguration <Hashtable>]
      [-ClientConfiguration <IMicrosoftGraphCustomExtensionClientConfiguration>]
      [-Description <String>]
      [-DisplayName <String>]
      [-EndpointConfiguration <Hashtable>]
      [-Id <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgIdentityCustomAuthenticationExtension
      -CustomAuthenticationExtensionId <String>
      -BodyParameter <Hashtable>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgIdentityCustomAuthenticationExtension
      -InputObject <IIdentitySignInsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-AuthenticationConfiguration <Hashtable>]
      [-ClientConfiguration <IMicrosoftGraphCustomExtensionClientConfiguration>]
      [-Description <String>]
      [-DisplayName <String>]
      [-EndpointConfiguration <Hashtable>]
      [-Id <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgIdentityCustomAuthenticationExtension
      -InputObject <IIdentitySignInsIdentity>
      -BodyParameter <Hashtable>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the properties of a customAuthenticationExtension object.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	CustomAuthenticationExtension.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	CustomAuthenticationExtension.ReadWrite.All	Not available.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.onTokenIssuanceStartCustomExtension"
	displayName = "onTokenIssuanceStartCustomExtension"
	description = "Fetch additional claims from custom user store"
	endpointConfiguration = @{
		"@odata.type" = "#microsoft.graph.httpRequestEndpoint"
		targetUrl = "https://authenticationeventsAPI.contoso.com"
	}
	authenticationConfiguration = @{
		"@odata.type" = "#microsoft.graph.azureAdTokenAuthentication"
		resourceId = "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
	}
	claimsForTokenConfiguration = @(
		@{
			claimIdInApiResponse = "DateOfBirth"
		}
		@{
			claimIdInApiResponse = "CustomRoles"
		}
	)
}

Update-MgIdentityCustomAuthenticationExtension -CustomAuthenticationExtensionId $customAuthenticationExtensionId -BodyParameter $params

This example shows how to use the Update-MgIdentityCustomAuthenticationExtension Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AuthenticationConfiguration

customExtensionAuthenticationConfiguration

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

customAuthenticationExtension

Type:	Hashtable
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ClientConfiguration

customExtensionClientConfiguration To construct, see NOTES section for CLIENTCONFIGURATION properties and create a hash table.

Type:	IMicrosoftGraphCustomExtensionClientConfiguration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomAuthenticationExtensionId

The unique identifier of customAuthenticationExtension

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Description for the customCalloutExtension object.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

Display name for the customCalloutExtension object.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EndpointConfiguration

customExtensionEndpointConfiguration

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

The unique identifier for an entity. Read-only.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

Type:	IIdentitySignInsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ProgressAction

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IIdentitySignInsIdentity

System.Collections.Hashtable

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCustomAuthenticationExtension

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.

CLIENTCONFIGURATION <IMicrosoftGraphCustomExtensionClientConfiguration>: customExtensionClientConfiguration

[(Any) <Object>]: This indicates any property can be added to this object.
[MaximumRetries <Int32?>]: The max number of retries that Microsoft Entra ID makes to the external API. Values of 0 or 1 are supported. If null, the default for the service applies.
[TimeoutInMilliseconds <Int32?>]: The max duration in milliseconds that Microsoft Entra ID waits for a response from the external app before it shuts down the connection. The valid range is between 200 and 2000 milliseconds. Default duration is 1000.

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

Dela via

Update-MgIdentityCustomAuthenticationExtension

Syntax

Description

Examples

Example 1: Code snippet

Parameters

-AdditionalProperties

-AuthenticationConfiguration

-BodyParameter

-ClientConfiguration

-Confirm

-CustomAuthenticationExtensionId

-Description

-DisplayName

-EndpointConfiguration

-Headers

-Id

-InputObject

-ProgressAction

-ResponseHeadersVariable

-WhatIf

Inputs

Outputs

Notes

Ytterligare resurser

Dela via

Update-MgIdentityCustomAuthenticationExtension

Syntax

Description

Examples

Example 1: Code snippet

Parameters

-AdditionalProperties

-AuthenticationConfiguration

-BodyParameter

-ClientConfiguration

-Confirm

-CustomAuthenticationExtensionId

-Description

-DisplayName

-EndpointConfiguration

-Headers

-Id

-InputObject

-ProgressAction

-ResponseHeadersVariable

-WhatIf

Inputs

Outputs

Notes

Related Links

Ytterligare resurser