Set-IDUserPhonePin
SYNOPSIS
Set a user’s phone PIN
SYNTAX
Set-IDUserPhonePin [-ID] <String> [-PhonePin] <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Sets the phone PIN used to authenticate via the Phone Call MFA mechanism for a specified user - equivalent to the self-service “Account > Authentication Factors > Phone PIN” setting in the user portal. This is unrelated to any lock PIN on a CyberArk mobile app installed on the user’s device - setting it will not change or be reflected by that.
EXAMPLES
Example 1
PS C:\> Set-IDUserPhonePin -ID 'a1b2c3d4-0000-0000-0000-000000000000' -PhonePin '1234'
Sets the specified user’s phone PIN.
PARAMETERS
-ID
The unique ID of the user to update.
Type: String
Parameter Sets: (All)
Aliases: Uuid
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PhonePin
The phone PIN to set.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
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: None
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: None
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.