Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-MgBetaIdentityCustomAuthenticationExtension
Create a new customAuthenticationExtension object. The following derived types are currently supported.
Note
To view the v1.0 release of this cmdlet, view New-MgIdentityCustomAuthenticationExtension
Syntax
CreateExpanded (Default)
New-MgBetaIdentityCustomAuthenticationExtension
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-AuthenticationConfiguration <hashtable>]
[-BehaviorOnError <hashtable>]
[-ClientConfiguration <IMicrosoftGraphCustomExtensionClientConfiguration>]
[-Description <string>]
[-DisplayName <string>]
[-EndpointConfiguration <hashtable>]
[-Id <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create
New-MgBetaIdentityCustomAuthenticationExtension
-BodyParameter <IMicrosoftGraphCustomAuthenticationExtension>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a new customAuthenticationExtension object. The following derived types are currently supported.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | CustomAuthenticationExtension.ReadWrite.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | CustomAuthenticationExtension.ReadWrite.All, |
Examples
Example 1: Create an onTokenIssuanceStartCustomExtension object
Import-Module Microsoft.Graph.Beta.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"
}
clientConfiguration = @{
timeoutInMilliseconds = 2000
maximumRetries = 1
}
claimsForTokenConfiguration = @(
@{
claimIdInApiResponse = "DateOfBirth"
}
@{
claimIdInApiResponse = "CustomRoles"
}
)
}
New-MgBetaIdentityCustomAuthenticationExtension -BodyParameter $params
This example will create an ontokenissuancestartcustomextension object
Example 2: Create an onAttributeCollectionStartCustomExtension object
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.onAttributeCollectionStartCustomExtension"
displayName = "attributeCollectionStartName"
description = "example description"
authenticationConfiguration = @{
"@odata.type" = "#microsoft.graph.azureAdTokenAuthentication"
resourceId = "api://contoso.com/fb96de85-2abe-4b02-b45f-64ba122c509e"
}
endpointConfiguration = @{
"@odata.type" = "#microsoft.graph.httpRequestEndpoint"
targetUrl = "https://contoso.com"
}
clientConfiguration = @{
timeoutInMilliseconds = 2000
maximumRetries = 1
}
}
New-MgBetaIdentityCustomAuthenticationExtension -BodyParameter $params
This example will create an onattributecollectionstartcustomextension object
Example 3: Create an onAttributeCollectionSubmitCustomExtension object
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.onAttributeCollectionSubmitCustomExtension"
displayName = "attributeCollectionSubmitName"
description = "example description"
authenticationConfiguration = @{
"@odata.type" = "#microsoft.graph.azureAdTokenAuthentication"
resourceId = "api://contoso.com/fb96de85-2abe-4b02-b45f-64ba122c509e"
}
endpointConfiguration = @{
"@odata.type" = "#microsoft.graph.httpRequestEndpoint"
targetUrl = "https://contoso.com"
}
clientConfiguration = @{
timeoutInMilliseconds = 2000
maximumRetries = 1
}
}
New-MgBetaIdentityCustomAuthenticationExtension -BodyParameter $params
This example will create an onattributecollectionsubmitcustomextension object
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AuthenticationConfiguration
customExtensionAuthenticationConfiguration
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BehaviorOnError
customExtensionBehaviorOnError
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BodyParameter
customAuthenticationExtension To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCustomAuthenticationExtension |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ClientConfiguration
customExtensionClientConfiguration To construct, see NOTES section for CLIENTCONFIGURATION properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCustomExtensionClientConfiguration |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-Description
Description for the customCalloutExtension object.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisplayName
Display name for the customCalloutExtension object.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EndpointConfiguration
customExtensionEndpointConfiguration
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-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
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-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
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.Beta.PowerShell.Models.IMicrosoftGraphCustomAuthenticationExtension
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCustomAuthenticationExtension
{{ 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 <IMicrosoftGraphCustomAuthenticationExtension>: customAuthenticationExtension
[(Any) <Object>]: This indicates any property can be added to this object.
[AuthenticationConfiguration <IMicrosoftGraphCustomExtensionAuthenticationConfiguration>]: customExtensionAuthenticationConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[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.
If null, the default for the service applies.
[Description <String>]: Description for the customCalloutExtension object.
[DisplayName <String>]: Display name for the customCalloutExtension object.
[EndpointConfiguration <IMicrosoftGraphCustomExtensionEndpointConfiguration>]: customExtensionEndpointConfiguration
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[BehaviorOnError <IMicrosoftGraphCustomExtensionBehaviorOnError>]: customExtensionBehaviorOnError
[(Any) <Object>]: This indicates any property can be added to this object.
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.
If null, the default for the service applies.
