Get-R1PasswordPolicy
Get-R1PasswordPolicy
SYNOPSIS
Returns password policies.
SYNTAX
All (Default)
Get-R1PasswordPolicy [<CommonParameters>]
PolicyName
Get-R1PasswordPolicy -policyName <String> [<CommonParameters>]
Default
Get-R1PasswordPolicy [-Default] [<CommonParameters>]
NewPolicy
Get-R1PasswordPolicy [-NewPolicy] [<CommonParameters>]
DESCRIPTION
Returns the password policies configured on the deployment.
With no parameters, the names of the configured policies are returned. Specify policyName to return the full settings of one policy - the API requires it as a query parameter. Specify Default for the default policy, which the API identifies by an empty policy name. Specify NewPolicy to return an empty policy populated with the API defaults, as a starting point.
EXAMPLES
Example 1
Get-R1PasswordPolicy
Returns the configured policy names.
Example 2
Get-R1PasswordPolicy -policyName 'Default'
Returns the full settings of the named policy.
Example 3
Get-R1PasswordPolicy -Default
Returns the full settings of the default policy.
Example 4
Get-R1PasswordPolicy -NewPolicy
Returns an empty policy populated with the API defaults.
PARAMETERS
-Default
Return the default policy, which the API identifies by an empty policy name.
Type: SwitchParameter
Parameter Sets: Default
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NewPolicy
Return an empty policy populated with the API defaults, as a starting point for a new one.
Type: SwitchParameter
Parameter Sets: NewPolicy
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-policyName
The name of the password policy. Required by the API as a query parameter on retrieval, update and deletion.
Type: String
Parameter Sets: PolicyName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.