Unlock-PASAccount
Unlock-PASAccount
SYNOPSIS
Checks-in one or more exclusive access accounts, or unlocks an account checked-out or locked by another user.
SYNTAX
CheckIn (Default)
Unlock-PASAccount [-AccountID] <String[]> [-CheckIn] [-WhatIf] [-Confirm] [<CommonParameters>]
Unlock
Unlock-PASAccount [-AccountID] <String[]> [-Unlock] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Unlocks or Checks in an account, locked due to an exclusive account policy, to the Vault.
If the account is managed automatically by the CPM, after it is checked in,the password is changed immediately.
If the account is managed manually, a notification is sent to a user who is authorised to change the password.
The account is checked in automatically after it has been changed.
Requires Initiate CPM password management operations on the Safe where the account is stored.
Where a user holds the “Unlock Account” permission on a safe, they may use this function to issue an “Unlock” command on an account checked out or locked by another user.
Multiple accounts can be checked in, or unlocked, using a single bulk request by supplying more than one value for -AccountID.
Bulk check-in and bulk unlock require CyberArk version 15.2 or later.
EXAMPLES
EXAMPLE 1
Unlock-PASAccount -AccountID 21_3
Will check-in exclusive access account with ID of “21_3”
EXAMPLE 2
Get-PASAccount -Keywords xAccount | Unlock-PASAccount
Will check-in exclusive access account xAccount
EXAMPLE 3
Unlock-PASAccount -AccountID 21_3 -Unlock
Unlocks account with ID of “21_3” when locked by another user.
EXAMPLE 4
Unlock-PASAccount -AccountID 21_3, 22_4
Checks in accounts 21_3 and 22_4 in a single bulk request.
EXAMPLE 5
Unlock-PASAccount -AccountID 21_3, 22_4 -Unlock
Unlocks accounts 21_3 and 22_4 in a single bulk request.
PARAMETERS
-AccountID
The unique ID of the account.
This is retrieved by the Get-PASAccount function.
When more than one value is supplied, a bulk request is sent (bulk check-in for the CheckIn parameter set, bulk unlock for the Unlock parameter set).
Type: String[]
Parameter Sets: (All)
Aliases: id
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
-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
-CheckIn
Specifies that the account should be Checked-In
Type: SwitchParameter
Parameter Sets: CheckIn
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Unlock
Specifies that the account should be unlocked
Type: SwitchParameter
Parameter Sets: Unlock
Aliases:
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.
INPUTS
OUTPUTS
NOTES
Minimum CyberArk version 9.10 (Check-In Account) Minimum CyberArk version 11.6 (Unlock Account)
Bulk check-in and bulk unlock require CyberArk version 15.2 or later.
RELATED LINKS
https://pspas.pspete.dev/commands/Unlock-PASAccount
https://docs.cyberark.com/Product-Doc/OnlineHelp/pas/Latest/en/Content/PASIMP/AutoUnlockinPSM.htm
https://docs.cyberark.com/PAS/Latest/en/Content/SDK/Unlock-account.htm