Set-IDAuthenticationPolicy
SYNOPSIS
Update an existing authentication policy
SYNTAX
Set-IDAuthenticationPolicy [-PolicyName] <Object> [[-Description] <Object>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Update an existing authentication policy block identified by -PolicyName. The command looks up the policy’s current `Version` and `RevStamp` via `Get-IDAuthenticationPolicyBlock`, increments the version, and re-saves the policy block with the supplied description and link type.
EXAMPLES
Example 1
PS C:\> Set-IDAuthenticationPolicy -PolicyName 'Default Policy' -Description 'Updated MFA requirements'
Update the description of the existing “Default Policy” authentication policy.
Example 2
PS C:\> Set-IDAuthenticationPolicy -PolicyName 'Sales Role Policy' -LinkType Role
Change the link type of the existing “Sales Role Policy” authentication policy to Role.
PARAMETERS
-Description
A free-text description of the authentication policy. Defaults to an empty string.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PolicyName
The name of the existing authentication policy to update. Accepts pipeline input by property name.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.