Unlock-VPASExclusiveAccount


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

CHECK IN LOCKED ACCOUNT


Description:

USE THIS FUNCTION TO CHECK IN A LOCKED ACCOUNT IN CYBERARK


Syntax:

Unlock-VPASExclusiveAccount [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] [-AdminUnlock] [-token <Hashtable>] [<CommonParameters>]

Unlock-VPASExclusiveAccount -AcctID <String> [-AdminUnlock] [-token <Hashtable>] [<CommonParameters>]

Unlock-VPASExclusiveAccount -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-safe <String>
Safe name that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-platform <String>
PlatformID that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-username <String>
Username that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-address <String>
Address that will be used to query for the target account if no AcctID is passed

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AcctID <String>
Unique ID that maps to a single account, passing this variable will skip any query functions

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AdminUnlock [<SwitchParameter>]
Switch that will automatically unlock a locked account skipping the release worflow
This will be dependent on if user has UnlockAccounts safe permission

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$CheckInAccountStatus = Unlock-VPASExclusiveAccount -safe {SAFE VALUE} -username {USERNAME VALUE} -address {ADDRESS VALUE}

$CheckInAccountStatus = Unlock-VPASExclusiveAccount -AcctID {ACCTID VALUE}

$InputParameters = @{
        safe = "TargetSafeName"
        platform = "TargetPlatformID"
        username = "TargetUsername"
         address = "TargetAddress"
         AdminUnlock = $true|$false
}
$CheckInAccountStatus = Unlock-VPASExclusiveAccount -InputParameters $InputParameter

$InputParameters = @{
        AcctID = "22_132"
        AdminUnlock = $true|$false
}
$CheckInAccountStatus = Unlock-VPASExclusiveAccount -InputParameters $InputParameter


Outputs:

$true if successful

$false if failed