Clear-PASDependentLinkedAccount
Clear-PASDependentLinkedAccount
SYNOPSIS
Clears a linked account from a dependent account
SYNTAX
SaaS
Clear-PASDependentLinkedAccount [-AccountID] <String> [-dependentAccountId] <String>
[-extraPasswordIndex] <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
SelfHosted
Clear-PASDependentLinkedAccount [-AccountID] <String> [-dependentAccountId] <String> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Unlink an account from a dependent account
EXAMPLES
Example 1 - Privilege Cloud
Clear-PASDependentLinkedAccount -AccountID 32_1 -dependentAccountId 32_2 -extraPasswordIndex 1
Clears linked account index 1 from dependent account 32_2
Example 2 - Self-Hosted
Clear-PASDependentLinkedAccount -AccountID 32_1 -dependentAccountId 32_2
Clears the linked account from dependent account 32_2
Requires Self-Hosted CyberArk PAS v15.2 or greater.
Example 3 - WhatIf
Clear-PASDependentLinkedAccount -AccountID 32_1 -dependentAccountId 32_2 -WhatIf
Shows what would happen if the linked account were cleared from dependent account 32_2, but does not perform the action.
Example 4 - Pipeline Input
Get-PASAccount -id 32_1 | Clear-PASDependentLinkedAccount -dependentAccountId 32_2 -extraPasswordIndex 1
Clears linked account index 1 from dependent account 32_2, using pipeline input from Get-PASAccount for the parent account ID.
PARAMETERS
-AccountID
The ID of the parent account for the linked account
Type: String
Parameter Sets: (All)
Aliases: id
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-dependentAccountId
The ID of the Dependent account for the Parent Account
Type: String
Parameter Sets: (All)
Aliases: dependentid
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-extraPasswordIndex
The index of the account to unlink from the dependent account. Used for Privilege Cloud environments.
Type: Int32
Parameter Sets: SaaS
Aliases:
Required: True
Position: 3
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.
INPUTS
OUTPUTS
NOTES
RELATED LINKS
https://pspas.pspete.dev/commands/Clear-PASDependentLinkedAccount