New-MgBetaIdentityAuthenticationEventListener
Create a new authenticationEventListener object. You can create one of the following subtypes that are derived from authenticationEventListener.
Note
To view the v1.0 release of this cmdlet, view New-MgIdentityAuthenticationEventListener
Syntax
New-MgBetaIdentityAuthenticationEventListener
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AuthenticationEventsFlowId <String>]
[-Conditions <IMicrosoftGraphAuthenticationConditions>]
[-Id <String>]
[-Priority <Int32>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaIdentityAuthenticationEventListener
-BodyParameter <IMicrosoftGraphAuthenticationEventListener>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a new authenticationEventListener object. You can create one of the following subtypes that are derived from authenticationEventListener.
Permissions
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | EventListener.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | EventListener.ReadWrite.All | Not available. |
Examples
Example 1: Create an onTokenIssuanceStartListener object
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.onTokenIssuanceStartListener"
conditions = @{
applications = @{
includeAllApplications = $false
includeApplications = @(
@{
appId = "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
}
)
}
}
priority = 500
handler = @{
"@odata.type" = "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler"
customExtension = @{
id = "6fc5012e-7665-43d6-9708-4370863f4e6e"
}
}
}
New-MgBetaIdentityAuthenticationEventListener -BodyParameter $params
This example will create an ontokenissuancestartlistener object
Example 2: Create an onAttributeCollectionStartListener object
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.onAttributeCollectionStartListener"
priority = 500
conditions = @{
applications = @{
includeAllApplications = $false
includeApplications = @(
@{
appId = "a7eed01f-a333-4983-bc6b-d359ec9e5eef"
}
)
}
}
handler = @{
"@odata.type" = "#microsoft.graph.onAttributeCollectionStartCustomExtensionHandler"
customExtension = @{
id = "2d9c3e8d-88a9-444e-8c4c-f0c6c4fe1c02"
}
}
}
New-MgBetaIdentityAuthenticationEventListener -BodyParameter $params
This example will create an onattributecollectionstartlistener object
Example 3: Create an onAttributeCollectionSubmitListener object
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
"@odata.type" = "#microsoft.graph.onAttributeCollectionSubmitListener"
priority = 500
conditions = @{
applications = @{
includeAllApplications = $false
includeApplications = @(
@{
appId = "a7eed01f-a333-4983-bc6b-d359ec9e5eef"
}
)
}
}
handler = @{
"@odata.type" = "#microsoft.graph.onAttributeCollectionSubmitCustomExtensionHandler"
customExtension = @{
id = "66867d1f-7824-4f38-aad1-75da1ad09ee2"
}
}
}
New-MgBetaIdentityAuthenticationEventListener -BodyParameter $params
This example will create an onattributecollectionsubmitlistener object
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AuthenticationEventsFlowId
The identifier of the authenticationEventsFlow object.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
authenticationEventListener To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphAuthenticationEventListener |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Conditions
authenticationConditions To construct, see NOTES section for CONDITIONS properties and create a hash table.
Type: | IMicrosoftGraphAuthenticationConditions |
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 |
-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 |
-Priority
The priority of this handler. Between 0 (lower priority) and 1000 (higher priority).
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
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.Beta.PowerShell.Models.IMicrosoftGraphAuthenticationEventListener
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphAuthenticationEventListener
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 <IMicrosoftGraphAuthenticationEventListener>
: authenticationEventListener
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AuthenticationEventsFlowId <String>]
: The identifier of the authenticationEventsFlow object.[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.[IncludeAllApplications <Boolean?>]
: Whether the custom authentication extension should trigger for all applications with appIds specified in the includeApplications relationship. This property must be set to false for listener of type onTokenIssuanceStartListener.[IncludeApplications <IMicrosoftGraphAuthenticationConditionApplication-
[]>]
:[AppId <String>]
: The identifier for an application corresponding to a condition which will trigger an authenticationEventListener.
[Priority <Int32?>]
: The priority of this handler. Between 0 (lower priority) and 1000 (higher priority).
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.[IncludeAllApplications <Boolean?>]
: Whether the custom authentication extension should trigger for all applications with appIds specified in the includeApplications relationship. This property must be set to false for listener of type onTokenIssuanceStartListener.[IncludeApplications <IMicrosoftGraphAuthenticationConditionApplication-
[]>]
:[AppId <String>]
: The identifier for an application corresponding to a condition which will trigger an authenticationEventListener.