Add-PASAccount

SYNOPSIS

Adds a new privileged account to the Vault

Can target either the Gen2 API present from 10.4 onwards, or the previous Gen1 API endpoint.

SYNTAX

Gen2

Add-PASAccount [-name <String>] [-address <String>] [-userName <String>] -platformID <String>
 -SafeName <String> [-secretType <String>] [-secret <SecureString>] [-platformAccountProperties <Hashtable>]
 [-automaticManagementEnabled <Boolean>] [-manualManagementReason <String>] [-remoteMachines <String>]
 [-accessRestrictedToRemoteMachines <Boolean>] [<CommonParameters>]

Gen1

Add-PASAccount [-address <String>] -userName <String> -platformID <String> -SafeName <String>
 [-accountName <String>] -password <SecureString> [-disableAutoMgmt <Boolean>]
 [-disableAutoMgmtReason <String>] [-groupName <String>] [-groupPlatformID <String>] [-Port <Int32>]
 [-ExtraPass1Name <String>] [-ExtraPass1Folder <String>] [-ExtraPass1Safe <String>] [-ExtraPass3Name <String>]
 [-ExtraPass3Folder <String>] [-ExtraPass3Safe <String>] [-DynamicProperties <Hashtable>] [<CommonParameters>]

DESCRIPTION

Adds a new privileged account to the Vault.

Parameters are processed to create request object from passed parameters in the required format.

EXAMPLES

EXAMPLE 1

Add-PASAccount -address ThisServer -userName ThisUser -platformID UNIXSSH -SafeName UNIXSafe -automaticManagementEnabled $false

Using the Gen2 API, adds an account which is disabled for automatic password management

Requires minimum version of 10.4

EXAMPLE 2

Add-PASAccount -safe Prod_Access -PlatformID WINDOMAIN -Address domain.com -Password $secureString -username domainUser

Using the Gen1 API, adds account domain.com\domainuser to the Prod_Access Safe using the WINDOMAIN platform.

The contents of $secureString will be set as the password value.

EXAMPLE 3

$props = @{SSHCertificate = "yes";}
Add-PASAccount -address domain -userName ThisUser -platformID UNIXVIASSHCERTIFICATE -SafeName UNIXSafe -secretType Key -secret $key -platformAccountProperties $props

Using the Gen2 API, adds an account configured for the Unix via SSH Certificate platform

Requires minimum version of 10.4 Unix via SSH Certificate platform is supported in versions 11.2 and above.

PARAMETERS

-name

The name of the account.

Requires minimum version of 10.4

Type: String
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-address

The Address of the machine where the account will be used

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-userName

Username on the target machine

Type: String
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Type: String
Parameter Sets: Gen1
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-platformID

The CyberArk platform to assign to the account

Type: String
Parameter Sets: (All)
Aliases: PolicyID

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SafeName

The safe where the account will be created

Type: String
Parameter Sets: (All)
Aliases: safe

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-secretType

The type of password.

Requires minimum version of 10.4

Type: String
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-secret

The password value

Requires minimum version of 10.4

Type: SecureString
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-platformAccountProperties

key-value pairs to associate with the account, as defined by the account platform.

These properties are validated against the mandatory and optional properties of the specified platform’s definition.

Requires minimum version of 10.4

Type: Hashtable
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-automaticManagementEnabled

Whether CPM Password Management should be enabled

Requires minimum version of 10.4

Type: Boolean
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-manualManagementReason

A reason for disabling CPM Password Management

Requires minimum version of 10.4

Type: String
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-remoteMachines

For supported platforms, a list of remote machines the account can connect to.

Requires minimum version of 10.4

Type: String
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-accessRestrictedToRemoteMachines

Whether access is restricted to the defined remote machines.

Requires minimum version of 10.4

Type: Boolean
Parameter Sets: Gen2
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False