Clear-PASLinkedAccount
Clear-PASLinkedAccount
SYNOPSIS
Clears one or more linked account associations.
SYNTAX
Clear-PASLinkedAccount [-AccountID] <String[]> [-extraPasswordIndex] <Int32[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Clears the association between a linked account and a source account.
Multiple accounts can be processed in a single bulk request by supplying more than one value for -AccountID.
Bulk unlinking requires CyberArk version 15.2 or later.
The following Safe authorizations are required on the Safe where the source account is stored to run this command:
- List accounts
- Update account properties
- Manage Safe
- Only required when
RequireManageSafeToClearLinkedAccountis enabled in the configuration.
- Only required when
EXAMPLES
EXAMPLE 1
Clear-PASLinkedAccount -AccountID 12_34 -extraPasswordIndex 3
Clears extraPass3 from account with ID 12_34
EXAMPLE 2
Clear-PASLinkedAccount -AccountID 12_34, 56_78 -extraPasswordIndex 3
Clears extraPass3 from accounts with IDs 12_34 and 56_78 in a single bulk request.
EXAMPLE 3
Clear-PASLinkedAccount -AccountID 12_34 -extraPasswordIndex 3 -WhatIf
Shows what would happen if extraPass3 were cleared from account 12_34, but does not perform the action.
EXAMPLE 4
Get-PASAccount -id 12_34 | Clear-PASLinkedAccount -extraPasswordIndex 3
Clears extraPass3 from the account returned by Get-PASAccount, using pipeline input for -AccountID.
PARAMETERS
-AccountID
The id value of the source account.
When more than one value is supplied, a bulk unlink request is sent.
Type: String[]
Parameter Sets: (All)
Aliases: id
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-extraPasswordIndex
The linked account’s extra password index.
The index can be for a Reconcile account, Logon account, or other linked account that is defined in the Platform configuration.
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
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
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.